Details

Reviewers

staniek
piggz

Group Reviewers

KDb

Commits

R15:0f477121d325: New: KDbAddQCH.cmake for creating an API dox QCH file during the build

Summary

Custom copy of upcoming ECMAddQCH.cmake, see https://phabricator.kde.org/D2854
for existing issues and open questions.

Test Plan

KDb.qch generated by this: https://share.kde.org/index.php/s/wpRRWfYeZKaccjN

Diff Detail

Repository

R15 KDb

Branch

addQCH

Lint

No Linters Available

Unit

No Unit Test Coverage

kossebau updated this revision to Diff 8531.Nov 26 2016, 12:52 PM

kossebau retitled this revision from to New: KDbAddQCH.cmake for creating an API dox QCH file during the build.

kossebau updated this object.

kossebau edited the test plan for this revision. (Show Details)

kossebau added reviewers: KDb, staniek, piggz.

Restricted Application added a project: KDb. · View Herald TranscriptNov 26 2016, 12:52 PM

fix: kdb_install_qch_export needs to be called after the target is defined

apply all changes also done to the kproperty patch

workaround cmake_parse_arguments not defining variables for empty multi-var arguments

staniek requested changes to this revision.Nov 29 2016, 5:20 PM

staniek edited edge metadata.

staniek added inline comments.

cmake/modules/KDbAddQCH.cmake
502	Curent message may be not informative enough so I propose: Unable to find the doxygen utility -> Unable to find the doxygen utility version ${DOXYGEN_MIN_VERSION) (and for the other repos) I just realized I have Doxygen 1.8.12, which is the last released. What's special in 1.8.13?

This revision now requires changes to proceed.Nov 29 2016, 5:20 PM

improve finding tools, install QCH files to share/doc/QCH if not Qt ones

kossebau added inline comments.Dec 1 2016, 1:21 AM

cmake/modules/KDbAddQCH.cmake
502	Alternative proposal (as implemented in updated patch): list the missing tools with version number in the normal feature_summary, so there is one central place as usual. What do you think, even better? What's special in 1.8.13? It will have (once released) the mentioned patch for doxygen which fixes the hardcoded JS files not being added to the QCH file. openSUSE's doxygen package are currently prepared to include the patch already, see https://bugzilla.suse.com/show_bug.cgi?id=1011331 :)

properly use purpose property with set_package_properties for used tools

staniek accepted this revision.Dec 4 2016, 9:20 PM

staniek edited edge metadata.

staniek added inline comments.

cmake/modules/KDbAddQCH.cmake
276	QCH uppercase? What's this convention?
502	Very good.

This revision is now accepted and ready to land.Dec 4 2016, 9:20 PM

staniek requested changes to this revision.Dec 4 2016, 9:23 PM

staniek edited edge metadata.

staniek added inline comments.

cmake/modules/KDbAddQCH.cmake
276	please tell me if the files are co-installable, i.e. paths use ${KDB_BASE_NAME} or so

This revision now requires changes to proceed.Dec 4 2016, 9:23 PM

kossebau added inline comments.Dec 4 2016, 9:59 PM

cmake/modules/KDbAddQCH.cmake
276	Is was following the uppercase HTML which KDEInstallDirs is using for the DOCBUNDLEDIR vars. But would agree that lowercase feels more natural on *nixoid systems, will change.
276	Co-installability in the same directory completely depends on what is used with the `OUTPUT_BASENAME` argument in the `kdb_add_qch(...)` call. Currently it is just `KDb`, so will not work. Changing now to `${KDB_BASE_NAME}`

lowercase doc/qch, use ${KDB_BASE_NAME} fir output files

Very good, thanks Friedrich!

This revision is now accepted and ready to land.Dec 4 2016, 10:04 PM

Thanks for the review! Will apply later tonight and then also transfer the changes developed here to KProperty and KReport, without review, okay?

okay!

staniek awarded a token.Dec 4 2016, 11:19 PM

Closed by commit R15:0f477121d325: New: KDbAddQCH.cmake for creating an API dox QCH file during the build (authored by kossebau). · Explain WhyDec 4 2016, 11:38 PM

This revision was automatically updated to reflect the committed changes.

		Path
M		CMakeLists.txt (3 lines)
A	M	cmake/modules/FindQHelpGenerator.cmake (46 lines)
A	M	cmake/modules/KDbAddQCH.cmake (650 lines)
A	M	cmake/modules/KDbDoxygenQCH.config.in (236 lines)
A	M	cmake/modules/KDbDoxygenQCHLayout.xml (194 lines)
A	M	cmake/modules/KDbQueryQmake.cmake (57 lines)
M		src/CMakeLists.txt (31 lines)
M		src/KDbConfig.cmake.in (1 line)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	8531	39f0447		Nov 26 2016, 12:52 PM	★	★
Diff 2	8553	39f0447	fix: kdb_install_qch_export needs to be called after the target is defined	Nov 27 2016, 5:31 PM	★	★
Diff 3	8577	39f0447	apply all changes also done to the kproperty patch	Nov 28 2016, 8:02 PM	★	★
Diff 4	8583	39f0447	workaround cmake_parse_arguments not defining variables for empty multi-var arguments	Nov 29 2016, 1:00 AM	★	★
Diff 5	8657	39f0447	improve finding tools, install QCH files to share/doc/QCH if not Qt ones	Dec 1 2016, 1:11 AM	★	★
Diff 6	8745	39f0447	properly use purpose property with set_package_properties for used tools	Dec 4 2016, 4:59 PM	★	★
Diff 7	8750	39f0447	lowercase doc/qch, use ${KDB_BASE_NAME} fir output files	Dec 4 2016, 9:59 PM	★	★
Diff 8	8753	f5e6d62	R15:0f477121d3256470508efbebca5e8665ce9bfc57	Dec 4 2016, 11:31 PM	★	★

New: KDbAddQCH.cmake for creating an API dox QCH file during the build
ClosedPublic
Actions

Details

Diff Detail

Revision Contents
Changeset List

Diff 8745

CMakeLists.txt

cmake/modules/FindQHelpGenerator.cmake

cmake/modules/KDbAddQCH.cmake

cmake/modules/KDbDoxygenQCH.config.in

cmake/modules/KDbDoxygenQCHLayout.xml

cmake/modules/KDbQueryQmake.cmake

src/CMakeLists.txt

src/KDbConfig.cmake.in

New: KDbAddQCH.cmake for creating an API dox QCH file during the buildClosedPublicActions

Details

Diff Detail

Revision ContentsChangeset List

Diff 8745

CMakeLists.txt

cmake/modules/FindQHelpGenerator.cmake

cmake/modules/KDbAddQCH.cmake

cmake/modules/KDbDoxygenQCH.config.in

cmake/modules/KDbDoxygenQCHLayout.xml

cmake/modules/KDbQueryQmake.cmake

src/CMakeLists.txt

src/KDbConfig.cmake.in

New: KDbAddQCH.cmake for creating an API dox QCH file during the build
ClosedPublic
Actions

Revision Contents
Changeset List