1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

revamp doc generation targets

Browse Source 
- the old docs target becomes html_docs
- a new qch_docs target is added. the .qch files end up directly in
  QT_INSTALL_DOCS, wihout any subdirectories in between
- the new docs target invokes html_docs and qch_docs
- respective un-/install targets are added as well. note that the
  install targets don't depend on the build targets, as it's virtually
  impossible to get the dependencies right throughout the hierarchy.

Change-Id: I07a2589db8252371e77cf925c47c4e59fbd1b2ca
Reviewed-by: hjk <qthjk@ovi.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
This commit is contained in:
Oswald Buddenhagen 2012-11-26 21:17:27 +01:00 committed by The Qt Project
parent 80b99a6dd7
commit 6133c8a9e7
3 changed files with 38 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
mkspecs/features/default_post.prf
View File

@ -62,10 +62,12 @@ QMAKE_LIBDIR += $$QMAKE_LIBDIR_POST
prepare_docs { prepare_docs {
prepareRecursiveTarget(prepare_docs) prepareRecursiveTarget(prepare_docs)
prepareRecursiveTarget(generate_docs) prepareRecursiveTarget(generate_docs)
docs.commands = $(MAKE) -f $(MAKEFILE) prepare_docs && $(MAKE) -f $(MAKEFILE) generate_docs html_docs.commands = $(MAKE) -f $(MAKEFILE) prepare_docs && $(MAKE) -f $(MAKEFILE) generate_docs
} else { } else {
prepareRecursiveTarget(docs) prepareRecursiveTarget(html_docs)
} }
prepareRecursiveTarget(qch_docs)
prepareRecursiveTarget(docs)
} else { } else {
# apps and libs only generate docs if QMAKE_DOCS is set # apps and libs only generate docs if QMAKE_DOCS is set
!isEmpty(QMAKE_DOCS) { !isEmpty(QMAKE_DOCS) {
@ -75,24 +77,35 @@ QMAKE_LIBDIR += $$QMAKE_LIBDIR_POST
!isEmpty(QMAKE_DOCS_OUTPUTDIR):QMAKE_DOCS_OPTIONS += -outputdir $$QMAKE_DOCS_OUTPUTDIR !isEmpty(QMAKE_DOCS_OUTPUTDIR):QMAKE_DOCS_OPTIONS += -outputdir $$QMAKE_DOCS_OUTPUTDIR
!isEmpty(QMAKE_DOCS_INSTALLDIR):QMAKE_DOCS_OPTIONS += -installdir $$QMAKE_DOCS_INSTALLDIR !isEmpty(QMAKE_DOCS_INSTALLDIR):QMAKE_DOCS_OPTIONS += -installdir $$QMAKE_DOCS_INSTALLDIR
doc_command = $$QDOC $$QMAKE_DOCS_OPTIONS $$QDOC_INDEX $$QMAKE_DOCS doc_command = $$QDOC $$QMAKE_DOCS_OPTIONS $$QDOC_INDEX $$QMAKE_DOCS
prepare_docs { prepare_docs {
prepare_docs.commands += $$doc_command -prepare -no-link-errors prepare_docs.commands += $$doc_command -prepare -no-link-errors
generate_docs.commands += $$doc_command -generate generate_docs.commands += $$doc_command -generate
docs.depends += generate_docs html_docs.depends += generate_docs
} else { } else {
docs.commands += $$doc_command html_docs.commands += $$doc_command
} }
qtPrepareTool(QHELPGENERATOR, qhelpgenerator)
isEmpty(QMAKE_DOCS_TARGET): QMAKE_DOCS_TARGET = $$basename(QMAKE_DOCS_OUTPUTDIR)
qch_docs.commands = $$QHELPGENERATOR $$QMAKE_DOCS_OUTPUTDIR/$${QMAKE_DOCS_TARGET}.qhp -o $$QMAKE_DOCS_BASE_OUTDIR/$${QMAKE_DOCS_TARGET}.qch
} }
} }
QMAKE_EXTRA_TARGETS += docs docs.commands = $(MAKE) -f $(MAKEFILE) html_docs && $(MAKE) -f $(MAKEFILE) qch_docs
QMAKE_EXTRA_TARGETS += html_docs qch_docs docs
prepare_docs: QMAKE_EXTRA_TARGETS += prepare_docs generate_docs prepare_docs: QMAKE_EXTRA_TARGETS += prepare_docs generate_docs
} }
!contains(QMAKE_EXTRA_TARGETS, install_docs) { !contains(QMAKE_EXTRA_TARGETS, install_docs) {
contains(TEMPLATE, subdirs) { contains(TEMPLATE, subdirs) {
prepareRecursiveTarget(install_html_docs)
prepareRecursiveTarget(uninstall_html_docs)
prepareRecursiveTarget(install_qch_docs)
prepareRecursiveTarget(uninstall_qch_docs)
prepareRecursiveTarget(install_docs) prepareRecursiveTarget(install_docs)
prepareRecursiveTarget(uninstall_docs) prepareRecursiveTarget(uninstall_docs)
} }
QMAKE_EXTRA_TARGETS += install_docs uninstall_docs QMAKE_EXTRA_TARGETS += \
install_html_docs uninstall_html_docs \
install_qch_docs uninstall_qch_docs \
install_docs uninstall_docs
} }

23
mkspecs/features/qt_installs.prf
View File

@ -49,13 +49,20 @@ qt_install_module {
} }
qt_install_module_docs { qt_install_module_docs {
module_docs.files = $$QMAKE_DOCS_OUTPUTDIR inst_html_docs.files = $$QMAKE_DOCS_OUTPUTDIR
module_docs.path = $$[QT_INSTALL_DOCS] inst_html_docs.path = $$[QT_INSTALL_DOCS]
module_docs.CONFIG += no_check_exist directory no_default_install inst_html_docs.CONFIG += no_check_exist directory no_default_install
module_docs.depends += docs INSTALLS += inst_html_docs
INSTALLS += module_docs
install_docs.depends = install_module_docs inst_qch_docs.files = $$QMAKE_DOCS_BASE_OUTDIR/$${QMAKE_DOCS_TARGET}.qch
uninstall_docs.depends = uninstall_module_docs inst_qch_docs.path = $$[QT_INSTALL_DOCS]
QMAKE_EXTRA_TARGETS += install_docs uninstall_docs inst_qch_docs.CONFIG += no_check_exist no_default_install
INSTALLS += inst_qch_docs
install_html_docs.depends = install_inst_html_docs
uninstall_html_docs.depends = uninstall_inst_html_docs
install_qch_docs.depends = install_inst_qch_docs
uninstall_qch_docs.depends = uninstall_inst_qch_docs
install_docs.depends = install_html_docs install_qch_docs
uninstall_docs.depends = uninstall_html_docs uninstall_qch_docs
} }

4
mkspecs/features/qt_module.prf
View File

@ -114,7 +114,9 @@ CONFIG += qmake_cache target_qt
doc_subdir = doc doc_subdir = doc
unset(QMAKE_DOCS_INDEX) unset(QMAKE_DOCS_INDEX)
QMAKE_DOCS_OUTPUTDIR = $$MODULE_BASE_OUTDIR/$$doc_subdir/qt$${MODULE} QMAKE_DOCS_BASE_OUTDIR = $$MODULE_BASE_OUTDIR/$$doc_subdir
QMAKE_DOCS_OUTPUTDIR = $$QMAKE_DOCS_BASE_OUTDIR/qt$${MODULE}
QMAKE_DOCS_TARGET = $$replace(QMAKE_DOCS, ^(.*/)?(.*)\\.qdocconf$, \\2)
for(qmod, QMAKEMODULES): \ for(qmod, QMAKEMODULES): \
QMAKE_DOCS_INDEX += $$section(qmod, /, 0, -3)/$$doc_subdir QMAKE_DOCS_INDEX += $$section(qmod, /, 0, -3)/$$doc_subdir