Export a proper shared library for KDocTools
ClosedPublic
Actions

Authored by ltoscano on Mar 1 2017, 12:28 AM.

Details

Reviewers

Commits

R238:620b0206ac89: Export a proper shared library for KDocTools

Summary

This is a unique situation, as the static library was supposed to be
temporary, and the only users are kio_help/kio_ghelp inside KIO.
The shared library is going to be the "real" supported library of
KDocTools, with more content in the future.

prepare a new KF5::DocTools shared library with the same content, but export only the functions which are really used by KIO.
still install the old library (minus an unused header) to allow KIO to still compile until the patches which makes it use the shared library is ported.

No functionality should be affected.

Test Plan

The code compiles, and KIO still compiles (kio_help apparently works).

Diff Detail

Repository

R238 KDocTools

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

ltoscano created this revision.Mar 1 2017, 12:28 AM

Restricted Application added projects: Frameworks, Documentation. · View Herald TranscriptMar 1 2017, 12:28 AM

Restricted Application added subscribers: Documentation, Frameworks. · View Herald Transcript

ltoscano added a dependent revision: D4850: Use the new shared library exported by KDocTools.Mar 1 2017, 12:30 AM

ltoscano added a reviewer: dfaure.

dfaure added inline comments.Mar 2 2017, 9:24 AM

src/docbookxslt.h
2	copyright header missing
14	docu?
24	docu?
26	docu?
27	(as expected) docu? ;) missing spaces around '='
src/docbookxslt_p.h
2	missing copyright header

ltoscano added inline comments.Mar 2 2017, 10:06 AM

src/docbookxslt.h
2	For this and all the other notes about missing copyright: I did not write the original code, just reshuffled it in this header (ok, apart one function), so I guess I should find the copyright of people who first wrote the functions?

dfaure added inline comments.Mar 2 2017, 10:15 AM

src/docbookxslt.h
2	Actually I think I remember reading that API isn't copyrighted, only implementation, so you could just stick your own copyright at the top of that file (my point being especially about the license more than the copyright). But I am no lawyer. (If you'd rather do the archeology, this is at least a possible fallback plan....)

Add descriptions and copyrights

Copyrights from the people who touched the signature from this
file and its ancestors.

Eyes bleeding after digging into the history back to the cvs2svn conversion. At least I will be able to finally update the copyright of the other files (even if apparently originally kdoctools was BSD-like, need to investigate more).
Anyway, if this is accepted, can I push also a review which removes the export of the static library after that KIO is fixed? Or do we need to keep that as well around? (I hope not).

ltoscano marked 3 inline comments as done.Mar 2 2017, 11:06 PM

ltoscano added inline comments.

src/docbookxslt_p.h
2	This is not exported, can I fix it later with the other files?

dfaure accepted this revision.Mar 3 2017, 11:57 AM

dfaure added inline comments.

src/docbookxslt_p.h
2	Sure.

This revision is now accepted and ready to land.Mar 3 2017, 11:57 AM

I think you can remove the static lib, yes. It didn't "look" like a proper KF5 lib, being the only static one, and the functions being undocumented, etc.

Closed by commit R238:620b0206ac89: Export a proper shared library for KDocTools (authored by ltoscano). · Explain WhyMar 3 2017, 4:19 PM

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

		Path
M		CMakeLists.txt (1 line)
M		src/CMakeLists.txt (40 lines)
A	M	src/docbookxslt.h (70 lines)
A	M	src/docbookxslt_p.h (11 lines)
M		src/meinproc.cpp (5 lines)
M		src/meinproc_common.cpp (3 lines)
M		src/xslt.h (28 lines)
M		src/xslt.cpp (15 lines)
M		src/xslt_kde.cpp (4 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	11982	be23cd4		Mar 1 2017, 12:28 AM	★	★
Diff 2	12097	be23cd4	Add descriptions and copyrights	Mar 2 2017, 10:33 PM	★	★
Diff 3	12132	e77f4f7	R238:620b0206ac890ee7f91332d621506b3cb6453baa	Mar 3 2017, 4:01 PM	★	★