AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1f8d9d2423
qt5base-lts/mkspecs/features/qt_docs.prf

86 lines
3.0 KiB
Plaintext
Raw Normal View History

mark a bunch of features as internal Change-Id: I5ad28827ff317985414e859263af85ceec31207c Reviewed-by: Stephen Kelly <stephen.kelly@kdab.com>
2012-12-11 21:08:15 +00:00
#
# W A R N I N G
# -------------
#
# This file is not part of the Qt API. It exists purely as an
# implementation detail. It may change from version to version
# without notice, or even be removed.
#
# We mean it.
#
centralize doc target related code Change-Id: I710a7f2fc3422ec8ba5b8e90bfd92e7931092ad0 Reviewed-by: Lars Knoll <lars.knoll@digia.com> Reviewed-by: hjk <qthjk@ovi.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2012-11-30 20:07:47 +00:00
!exists($$QMAKE_DOCS): error("Cannot find documentation specification file $$QMAKE_DOCS")
load(qt_build_paths)
QMAKE_DOCS_BASE_OUTDIR = $$MODULE_BASE_OUTDIR/doc
QMAKE_DOCS_TARGET = $$replace(QMAKE_DOCS, ^(.*/)?(.*)\\.qdocconf$, \\2)
isEmpty(QMAKE_DOCS_TARGETDIR): QMAKE_DOCS_TARGETDIR = $$QMAKE_DOCS_TARGET
QMAKE_DOCS_OUTPUTDIR = $$QMAKE_DOCS_BASE_OUTDIR/$$QMAKE_DOCS_TARGETDIR
qtPrepareTool(QDOC, qdoc)
QDOC += -outputdir $$QMAKE_DOCS_OUTPUTDIR
!build_online_docs: \
QDOC += -installdir $$[QT_INSTALL_DOCS]
pass (some) index dirs also during -prepare phase qdoc uses the indexes as "precompiled headers" to obtain type info necessary to properly parse sources. the indexes needed are the ones the module actually depends on (publically). Change-Id: I6aad0b511d2534d584f7947c8d800300eede94ff Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-05-23 16:05:05 +00:00
PREP_DOC_INDEXES =
don't pass -indexdir during prepare_docs phase the forward-referenced directories don't exist yet, so we get pointless warnings. in fact, this is why we do a multi-pass build in the first place, and consequently using indexes during the first pass is illogical. Task-number: QTBUG-32152 Change-Id: I66bf6b43238827e87cb8bf6932d581b808c1032d Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-07-05 13:42:39 +00:00
DOC_INDEXES =
ensure that there is always an -indexdir argument even if we are not doing a top-level build, we still need to specify an index dir. that may be the install dir or the qtbase build dir, depending on whether we are building against an installed prefix build or a non-prefix build (building against non-installed prefix builds outside a top-level build is inherently impossible). Task-number: QTBUG-35596 Change-Id: Ia37d429855480d3bfe36b7ee29e087029861bfc5 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
2014-05-21 12:22:31 +00:00
!isEmpty(QTREPOS) {
pass (some) index dirs also during -prepare phase qdoc uses the indexes as "precompiled headers" to obtain type info necessary to properly parse sources. the indexes needed are the ones the module actually depends on (publically). Change-Id: I6aad0b511d2534d584f7947c8d800300eede94ff Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-05-23 16:05:05 +00:00
prepare_docs {
# This is not for linking, but for providing type information.
mps =
deps = $$replace(QT, -private$, )
deps = $$resolve_depends(deps, "QT.")
for (d, deps): \
mps += $$dirname(QT.$${d}.libs)
mps = $$unique(mps)
for (mp, mps): \
PREP_DOC_INDEXES += -indexdir $$mp/doc
}
ensure that there is always an -indexdir argument even if we are not doing a top-level build, we still need to specify an index dir. that may be the install dir or the qtbase build dir, depending on whether we are building against an installed prefix build or a non-prefix build (building against non-installed prefix builds outside a top-level build is inherently impossible). Task-number: QTBUG-35596 Change-Id: Ia37d429855480d3bfe36b7ee29e087029861bfc5 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
2014-05-21 12:22:31 +00:00
for(qrep, QTREPOS): \
don't check for doc/ dirs' existence the doc/ dirs in the build dir won't be created until the docs have been built, so of course checking whether they are there during the qmake phase is counterproductive. this also means that we'll get some complaints about non-existing directories (for repos that don't create any docs). there is no reasonable way to query qmake which repos are affected, and writing shell-specific code to query it at make time seems a bit overengineered. Task-number: QTBUG-38862 Change-Id: Ie0588e75bfc39718fffd46f0df6785428e396eb2 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-05-23 14:30:46 +00:00
DOC_INDEXES += -indexdir $$qrep/doc
ensure that there is always an -indexdir argument even if we are not doing a top-level build, we still need to specify an index dir. that may be the install dir or the qtbase build dir, depending on whether we are building against an installed prefix build or a non-prefix build (building against non-installed prefix builds outside a top-level build is inherently impossible). Task-number: QTBUG-35596 Change-Id: Ia37d429855480d3bfe36b7ee29e087029861bfc5 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
2014-05-21 12:22:31 +00:00
} else {
pass (some) index dirs also during -prepare phase qdoc uses the indexes as "precompiled headers" to obtain type info necessary to properly parse sources. the indexes needed are the ones the module actually depends on (publically). Change-Id: I6aad0b511d2534d584f7947c8d800300eede94ff Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-05-23 16:05:05 +00:00
prepare_docs: \
PREP_DOC_INDEXES += -indexdir $$[QT_INSTALL_DOCS/get]
ensure that there is always an -indexdir argument even if we are not doing a top-level build, we still need to specify an index dir. that may be the install dir or the qtbase build dir, depending on whether we are building against an installed prefix build or a non-prefix build (building against non-installed prefix builds outside a top-level build is inherently impossible). Task-number: QTBUG-35596 Change-Id: Ia37d429855480d3bfe36b7ee29e087029861bfc5 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
2014-05-21 12:22:31 +00:00
DOC_INDEXES += -indexdir $$[QT_INSTALL_DOCS/get]
}
substitute fixed version numbers in qdocconf files with variables Change-Id: Ie57765c10a8e90d6fc74ee5a8fd84bfc7cd8bcf2 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
2013-01-30 16:20:33 +00:00
qtver.name = QT_VERSION
require modules to define their version otherwise they would inherit it from qtbase, which may effectively result in a lie if building against a different release. for convenience we define the version centrally per repo. qtbase is special, in that we use the version defined in qglobal.h to avoid defining it redundantly (the instance in qglobal.h is currently needed to bootstrap qmake; the configures would need some work to change this). Task-number: QTBUG-29838 Change-Id: Ie9a5b0ff0d64b69ff2d34af2f7c42d6278e957cc Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
2013-02-26 10:25:52 +00:00
qtver.value = $$VERSION
isEmpty(qtver.value): qtver.value = $$MODULE_VERSION
isEmpty(qtver.value): error("No version for documentation specified.")
substitute fixed version numbers in qdocconf files with variables Change-Id: Ie57765c10a8e90d6fc74ee5a8fd84bfc7cd8bcf2 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
2013-01-30 16:20:33 +00:00
qtmver.name = QT_VER
require modules to define their version otherwise they would inherit it from qtbase, which may effectively result in a lie if building against a different release. for convenience we define the version centrally per repo. qtbase is special, in that we use the version defined in qglobal.h to avoid defining it redundantly (the instance in qglobal.h is currently needed to bootstrap qmake; the configures would need some work to change this). Task-number: QTBUG-29838 Change-Id: Ie9a5b0ff0d64b69ff2d34af2f7c42d6278e957cc Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
2013-02-26 10:25:52 +00:00
qtmver.value = $$replace(qtver.value, ^(\\d+\\.\\d+).*$, \\1)
substitute fixed version numbers in qdocconf files with variables Change-Id: Ie57765c10a8e90d6fc74ee5a8fd84bfc7cd8bcf2 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
2013-01-30 16:20:33 +00:00
qtvertag.name = QT_VERSION_TAG
require modules to define their version otherwise they would inherit it from qtbase, which may effectively result in a lie if building against a different release. for convenience we define the version centrally per repo. qtbase is special, in that we use the version defined in qglobal.h to avoid defining it redundantly (the instance in qglobal.h is currently needed to bootstrap qmake; the configures would need some work to change this). Task-number: QTBUG-29838 Change-Id: Ie9a5b0ff0d64b69ff2d34af2f7c42d6278e957cc Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
2013-02-26 10:25:52 +00:00
qtvertag.value = $$replace(qtver.value, \.,)
move the setup of QT_INSTALL_DOCS from qdoc to qt_docs.prf this is a qt specific option and really should not be hard-coded. also, the implementation used undocumented api that is internal to the bootstrapped process, which made it impossible to de-bootstrap it. Change-Id: If706960671744e64a9a7c366437977a800a6058e Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
2013-03-15 16:22:31 +00:00
qtdocs.name = QT_INSTALL_DOCS
don't copy/symlink doc/global to build dir instead, use the files directly from the source dir. Change-Id: I03b728c66de6e03cade6dc153dcc78cea8e3f606 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
2013-06-11 14:21:01 +00:00
qtdocs.value = $$[QT_INSTALL_DOCS/src]
move the setup of QT_INSTALL_DOCS from qdoc to qt_docs.prf this is a qt specific option and really should not be hard-coded. also, the implementation used undocumented api that is internal to the bootstrapped process, which made it impossible to de-bootstrap it. Change-Id: If706960671744e64a9a7c366437977a800a6058e Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
2013-03-15 16:22:31 +00:00
qtAddToolEnv(QDOC, qtver qtmver qtvertag qtdocs)
centralize doc target related code Change-Id: I710a7f2fc3422ec8ba5b8e90bfd92e7931092ad0 Reviewed-by: Lars Knoll <lars.knoll@digia.com> Reviewed-by: hjk <qthjk@ovi.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2012-11-30 20:07:47 +00:00
doc_command = $$QDOC $$QMAKE_DOCS
prepare_docs {
pass (some) index dirs also during -prepare phase qdoc uses the indexes as "precompiled headers" to obtain type info necessary to properly parse sources. the indexes needed are the ones the module actually depends on (publically). Change-Id: I6aad0b511d2534d584f7947c8d800300eede94ff Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-05-23 16:05:05 +00:00
prepare_docs.commands += $$doc_command -prepare $$PREP_DOC_INDEXES -no-link-errors
don't pass -indexdir during prepare_docs phase the forward-referenced directories don't exist yet, so we get pointless warnings. in fact, this is why we do a multi-pass build in the first place, and consequently using indexes during the first pass is illogical. Task-number: QTBUG-32152 Change-Id: I66bf6b43238827e87cb8bf6932d581b808c1032d Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-07-05 13:42:39 +00:00
generate_docs.commands += $$doc_command -generate $$DOC_INDEXES
centralize doc target related code Change-Id: I710a7f2fc3422ec8ba5b8e90bfd92e7931092ad0 Reviewed-by: Lars Knoll <lars.knoll@digia.com> Reviewed-by: hjk <qthjk@ovi.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2012-11-30 20:07:47 +00:00
} else {
don't pass -indexdir during prepare_docs phase the forward-referenced directories don't exist yet, so we get pointless warnings. in fact, this is why we do a multi-pass build in the first place, and consequently using indexes during the first pass is illogical. Task-number: QTBUG-32152 Change-Id: I66bf6b43238827e87cb8bf6932d581b808c1032d Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-07-05 13:42:39 +00:00
html_docs.commands += $$doc_command $$DOC_INDEXES
centralize doc target related code Change-Id: I710a7f2fc3422ec8ba5b8e90bfd92e7931092ad0 Reviewed-by: Lars Knoll <lars.knoll@digia.com> Reviewed-by: hjk <qthjk@ovi.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2012-11-30 20:07:47 +00:00
}
!build_online_docs {
qtPrepareTool(QHELPGENERATOR, qhelpgenerator)
qch_docs.commands = $$QHELPGENERATOR $$QMAKE_DOCS_OUTPUTDIR/$${QMAKE_DOCS_TARGET}.qhp -o $$QMAKE_DOCS_BASE_OUTDIR/$${QMAKE_DOCS_TARGET}.qch
inst_html_docs.files = $$QMAKE_DOCS_OUTPUTDIR
inst_html_docs.path = $$[QT_INSTALL_DOCS]
don't make the doc installs depend on the regular build it's pretty pointless Change-Id: Icea0073683a2d949798147fba3fad5b3331b1125 Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
2012-12-04 20:55:06 +00:00
inst_html_docs.CONFIG += no_check_exist directory no_default_install no_build
centralize doc target related code Change-Id: I710a7f2fc3422ec8ba5b8e90bfd92e7931092ad0 Reviewed-by: Lars Knoll <lars.knoll@digia.com> Reviewed-by: hjk <qthjk@ovi.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2012-11-30 20:07:47 +00:00
INSTALLS += inst_html_docs
inst_qch_docs.files = $$QMAKE_DOCS_BASE_OUTDIR/$${QMAKE_DOCS_TARGET}.qch
inst_qch_docs.path = $$[QT_INSTALL_DOCS]
don't make the doc installs depend on the regular build it's pretty pointless Change-Id: Icea0073683a2d949798147fba3fad5b3331b1125 Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
2012-12-04 20:55:06 +00:00
inst_qch_docs.CONFIG += no_check_exist no_default_install no_build
centralize doc target related code Change-Id: I710a7f2fc3422ec8ba5b8e90bfd92e7931092ad0 Reviewed-by: Lars Knoll <lars.knoll@digia.com> Reviewed-by: hjk <qthjk@ovi.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2012-11-30 20:07:47 +00:00
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
}
Reference in New Issue Copy Permalink