feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity
Files
c62ad6c450df46ace5ed9e9354ed401b51a6911b
qt-creator/doc/doc.pri

94 lines
3.3 KiB
Plaintext
Raw Normal View History

Remove Qt version checks. Qt 5.3 is the minimum requirement these days. Remove all fallback code from sources and project files. Change-Id: If6188a471197acadda4d6baee71804ba1a8026c6 Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2014-08-29 13:18:41 +02:00
HELPGENERATOR = $$shell_path($$[QT_INSTALL_BINS]/qhelpgenerator) -platform minimal
QDOC_BIN = $$shell_path($$[QT_INSTALL_BINS]/qdoc)
Remove pre-Qt 5.3.1 code paths from main Qt Creator pro and pri files Change-Id: I71bee691a2b9bad7dbdb4ca9c0a938d4313305f7 Reviewed-by: hjk <hjk121@nokiamail.com>
2014-08-25 10:59:42 +02:00
QDOC_GLOBAL = QT_INSTALL_DOCS=$$[QT_INSTALL_DOCS/src] QDOC_INDEX_DIR=$$[QT_INSTALL_DOCS]
COMPAT =
Find qmake in the right location for Qt 4.6+
2009-08-21 12:52:54 +02:00
dynamically replace creator version during build ... instead of running a sed script over a lot of files on each version increment.
2010-11-01 18:51:20 +01:00
VERSION_TAG = $$replace(QTCREATOR_VERSION, "[-.]", )
Add documentation for extensions of Qml Performance Monitor Can be enabled by passing LICENSE_TYPE=enterprise to qmake. Change-Id: I49044c2425a056980b6e9f8377e6a33c1beaca5a Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2013-06-20 13:21:36 +02:00
isEmpty(LICENSE_TYPE):LICENSE_TYPE=opensource
Make Qt Creator documentation link to online docs Change-Id: I3f843831242929bd3e8427a56c8269c62c1812c1 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2012-05-15 09:57:07 +02:00
# unset the installdir for qdoc, so we force generation
# of URLs for the links to the Qt documentation
QMAKE_DOCS_INSTALLDIR =
de-duplicate qdoc command construction Change-Id: I83de381cbbee9a04432aeccbb202a13f746ef97e Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
2013-01-25 22:14:17 +01:00
defineReplace(cmdEnv) {
!equals(QMAKE_DIR_SEP, /): 1 ~= s,^(.*)$,(set \\1) &&,g
return("$$1")
}
integrate developer docs into the normal docs build Change-Id: Ie94fe37f9025643c35c14a224661295e6c4c9a41 Reviewed-on: http://codereview.qt.nokia.com/288 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Daniel Teske <daniel.teske@nokia.com>
2011-05-31 17:13:23 +02:00
defineReplace(qdoc) {
fix building against non-installed qt5 shadow builds the global qdoc configs may live in the source dir, but the indexes are always in the build dir. this will obviously only work for a non-prefix (developer) build of qt, as a non-installed prefix build is not usable from the outside. Task-number: QTCREATORBUG-11919 Change-Id: I268af2f075a098ac5fe788a2f85c754dc6e4e8b0 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2014-05-22 12:11:37 +02:00
return("$$cmdEnv(SRCDIR=$$PWD OUTDIR=$$1 QTC_VERSION=$$QTCREATOR_VERSION QTC_VERSION_TAG=$$VERSION_TAG QTC_LICENSE_TYPE=$$LICENSE_TYPE $$QDOC_GLOBAL) $$QDOC_BIN")
Initial import
2008-12-02 12:01:29 +01:00
}
Fixes: - Mac build (docs) and toplevel "make docs" target RevBy: - bjørn
2009-01-07 15:47:25 +01:00
QHP_FILE = $$OUT_PWD/doc/html/qtcreator.qhp
macx: compile doc into the right directory instead of copying it later
2009-11-02 21:36:26 +01:00
QCH_FILE = $$IDE_DOC_PATH/qtcreator.qch
Initial import
2008-12-02 12:01:29 +01:00
Doc: change doc configuration after moving files to subdirectories Change-Id: I6df3222a92efed43ede601e3f2e6f71b75782d22 Reviewed-on: http://codereview.qt-project.org/5602 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2011-09-27 11:21:21 +02:00
HELP_DEP_FILES = $$PWD/src/qtcreator.qdoc \
Updated the configuration files to use the updated qdoc. Updated qdoc to remove hard-coded dependencies on style sheets. Simplified the offline documentation, introducing an offline.css file to be used for documentation in Qt Creator.
2010-12-17 20:21:27 +01:00
$$PWD/config/macros.qdocconf \
$$PWD/config/qt-cpp-ignore.qdocconf \
Doc: remove support for building docs with Qt 4 The templates are fetched from qtbase/doc/global Change-Id: I15386a66e1dae552f5637062d9f176bf6565a834 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Eike Ziller <eike.ziller@theqtcompany.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-11-21 12:26:44 +01:00
$$PWD/config/qt-defines.qdocconf
Sync doc style with Qt, introduce online version (make docs_online) The spacing errors come from Qt, and should be fixed there. Reviewed-By: Oswald Buddenhagen
2010-06-15 14:45:14 +02:00
Doc: remove support for building docs with Qt 4 The templates are fetched from qtbase/doc/global Change-Id: I15386a66e1dae552f5637062d9f176bf6565a834 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Eike Ziller <eike.ziller@theqtcompany.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-11-21 12:26:44 +01:00
html_docs.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtcreator.qdocconf
Sync doc style with Qt, introduce online version (make docs_online) The spacing errors come from Qt, and should be fixed there. Reviewed-By: Oswald Buddenhagen
2010-06-15 14:45:14 +02:00
html_docs.depends += $$HELP_DEP_FILES
Initial import
2008-12-02 12:01:29 +01:00
html_docs.files = $$QHP_FILE
Doc: remove support for building docs with Qt 4 The templates are fetched from qtbase/doc/global Change-Id: I15386a66e1dae552f5637062d9f176bf6565a834 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Eike Ziller <eike.ziller@theqtcompany.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-11-21 12:26:44 +01:00
html_docs_online.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtcreator-online.qdocconf
Sync doc style with Qt, introduce online version (make docs_online) The spacing errors come from Qt, and should be fixed there. Reviewed-By: Oswald Buddenhagen
2010-06-15 14:45:14 +02:00
html_docs_online.depends += $$HELP_DEP_FILES
macx: compile doc into the right directory instead of copying it later
2009-11-02 21:36:26 +01:00
qch_docs.commands = $$HELPGENERATOR -o \"$$QCH_FILE\" $$QHP_FILE
Initial import
2008-12-02 12:01:29 +01:00
qch_docs.depends += html_docs
build dev docs in doc/html-dev instead of doc/api/html Change-Id: I42c13004e6a80b27c0f1690c76b35a0d40cee6ad Reviewed-on: http://codereview.qt.nokia.com/289 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@nokia.com>
2011-05-31 17:23:38 +02:00
DEV_QHP_FILE = $$OUT_PWD/doc/html-dev/qtcreator-dev.qhp
integrate developer docs into the normal docs build Change-Id: Ie94fe37f9025643c35c14a224661295e6c4c9a41 Reviewed-on: http://codereview.qt.nokia.com/288 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Daniel Teske <daniel.teske@nokia.com>
2011-05-31 17:13:23 +02:00
DEV_QCH_FILE = $$IDE_DOC_PATH/qtcreator-dev.qch
DEV_HELP_DEP_FILES = \
$$PWD/api/qtcreator-api.qdoc \
$$PWD/api/coding-style.qdoc \
$$PWD/api/external-tool-spec.qdoc \
$$PWD/api/qtcreator-dev.qdoc \
$$PWD/api/qtcreator-dev-wizards.qdoc \
Start on Creating Plugins documentation. Change-Id: Ic75775473cfb405cee5c53b2dc24144dba51a25c Reviewed-by: Leena Miettinen <riitta-leena.miettinen@nokia.com>
2011-10-10 08:32:07 +02:00
$$PWD/api/creating-plugins.qdoc \
$$PWD/api/getting-and-building.qdoc \
$$PWD/api/first-plugin.qdoc \
ExtensionSystem: Use Qt 5 plugin metadata instead of .pluginspec files Change-Id: I2b2c704260c613985a4bda179658ec1f8879e70f Reviewed-by: Christian Kandeler <christian.kandeler@digia.com> Reviewed-by: Christian Stenger <christian.stenger@digia.com> Reviewed-by: Daniel Teske <daniel.teske@digia.com> Reviewed-by: hjk <hjk121@nokiamail.com>
2014-08-26 17:29:38 +02:00
$$PWD/api/plugin-metadata.qdoc \
Add document on plugin life cycle. Change-Id: Iec868cdb8158726d91bcece935a9d6269219c056 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@nokia.com>
2011-11-28 08:27:50 +01:00
$$PWD/api/plugin-lifecycle.qdoc \
Add document about plugin manager/object pool. Change-Id: I60d3a60f2a6933f9b1fe1501bab4dca95dda4d8c Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2013-04-02 09:58:16 +02:00
$$PWD/api/pluginmanager.qdoc \
Doc: remove support for building docs with Qt 4 The templates are fetched from qtbase/doc/global Change-Id: I15386a66e1dae552f5637062d9f176bf6565a834 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Eike Ziller <eike.ziller@theqtcompany.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-11-21 12:26:44 +01:00
$$PWD/api/qtcreator-documentation.qdoc \
$$PWD/api/qtcreator-ui-text.qdoc \
$$PWD/api/qtcreator-dev.qdocconf
integrate developer docs into the normal docs build Change-Id: Ie94fe37f9025643c35c14a224661295e6c4c9a41 Reviewed-on: http://codereview.qt.nokia.com/288 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Daniel Teske <daniel.teske@nokia.com>
2011-05-31 17:13:23 +02:00
Doc: remove support for building docs with Qt 4 The templates are fetched from qtbase/doc/global Change-Id: I15386a66e1dae552f5637062d9f176bf6565a834 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Eike Ziller <eike.ziller@theqtcompany.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-11-21 12:26:44 +01:00
dev_html_docs.commands = $$qdoc($$OUT_PWD/doc/html-dev) $$PWD/api/qtcreator-dev.qdocconf
integrate developer docs into the normal docs build Change-Id: Ie94fe37f9025643c35c14a224661295e6c4c9a41 Reviewed-on: http://codereview.qt.nokia.com/288 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Daniel Teske <daniel.teske@nokia.com>
2011-05-31 17:13:23 +02:00
dev_html_docs.depends += $$DEV_HELP_DEP_FILES
Doc: remove support for building docs with Qt 4 The templates are fetched from qtbase/doc/global Change-Id: I15386a66e1dae552f5637062d9f176bf6565a834 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Eike Ziller <eike.ziller@theqtcompany.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-11-21 12:26:44 +01:00
dev_html_docs_online.commands = $$qdoc($$OUT_PWD/doc/html-dev) $$PWD/api/qtcreator-dev-online.qdocconf
integrate developer docs into the normal docs build Change-Id: Ie94fe37f9025643c35c14a224661295e6c4c9a41 Reviewed-on: http://codereview.qt.nokia.com/288 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Daniel Teske <daniel.teske@nokia.com>
2011-05-31 17:13:23 +02:00
dev_html_docs_online.depends += $$DEV_HELP_DEP_FILES
dev_qch_docs.commands = $$HELPGENERATOR -o \"$$DEV_QCH_FILE\" $$DEV_QHP_FILE
dev_qch_docs.depends += dev_html_docs
Docs: Install rules also for windows. Change-Id: I086f50adace23b8ffd07b431af5d5612ee747d01 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@nokia.com>
2012-01-26 20:24:46 +01:00
!macx {
move install code where it belongs make inst_qch_docs a separate "structure" to avoid confusion, and move the .files assignment to that structure's initializer. Change-Id: I896ccaabe701736ca82db31c189ed88a19d1e8ad Reviewed-on: http://codereview.qt.nokia.com/284 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Daniel Teske <daniel.teske@nokia.com>
2011-05-31 11:38:39 +02:00
inst_qch_docs.files = $$QCH_FILE
Use variables for install locations Define variables in qtcreator.pri for the various install locations, instead of hardcoding the paths everywhere where they are needed. Change-Id: Ia34de711a7f2be317272ede023e2a8b9cdcc30fe Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Christian Kandeler <christian.kandeler@theqtcompany.com>
2015-09-04 13:47:44 +02:00
inst_qch_docs.path = $$INSTALL_DOC_PATH
turn doc installation into an explicit target otherwise a "make install" without a prior "make docs" will fail. we cannot make install depend on docs, because the docs target does not (and cannot reasonably) have proper dependency tracking, so it would be rebuilt on every install attempt. we could make install depend on the presence of the docs files without checking their timestamps, but that would be dirty. Task-number: QTCREATORBUG-6245 Change-Id: I35a9b8110f8f12760a338b5b100d69e226d3c2e8 Reviewed-by: Daniel Molkentin <daniel.molkentin@nokia.com>
2011-11-14 12:02:06 +01:00
inst_qch_docs.CONFIG += no_check_exist no_default_install
move install code where it belongs make inst_qch_docs a separate "structure" to avoid confusion, and move the .files assignment to that structure's initializer. Change-Id: I896ccaabe701736ca82db31c189ed88a19d1e8ad Reviewed-on: http://codereview.qt.nokia.com/284 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Daniel Teske <daniel.teske@nokia.com>
2011-05-31 11:38:39 +02:00
INSTALLS += inst_qch_docs
integrate developer docs into the normal docs build Change-Id: Ie94fe37f9025643c35c14a224661295e6c4c9a41 Reviewed-on: http://codereview.qt.nokia.com/288 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Daniel Teske <daniel.teske@nokia.com>
2011-05-31 17:13:23 +02:00
inst_dev_qch_docs.files = $$DEV_QCH_FILE
Use variables for install locations Define variables in qtcreator.pri for the various install locations, instead of hardcoding the paths everywhere where they are needed. Change-Id: Ia34de711a7f2be317272ede023e2a8b9cdcc30fe Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Christian Kandeler <christian.kandeler@theqtcompany.com>
2015-09-04 13:47:44 +02:00
inst_dev_qch_docs.path = $$INSTALL_DOC_PATH
turn doc installation into an explicit target otherwise a "make install" without a prior "make docs" will fail. we cannot make install depend on docs, because the docs target does not (and cannot reasonably) have proper dependency tracking, so it would be rebuilt on every install attempt. we could make install depend on the presence of the docs files without checking their timestamps, but that would be dirty. Task-number: QTCREATORBUG-6245 Change-Id: I35a9b8110f8f12760a338b5b100d69e226d3c2e8 Reviewed-by: Daniel Molkentin <daniel.molkentin@nokia.com>
2011-11-14 12:02:06 +01:00
inst_dev_qch_docs.CONFIG += no_check_exist no_default_install
integrate developer docs into the normal docs build Change-Id: Ie94fe37f9025643c35c14a224661295e6c4c9a41 Reviewed-on: http://codereview.qt.nokia.com/288 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Daniel Teske <daniel.teske@nokia.com>
2011-05-31 17:13:23 +02:00
INSTALLS += inst_dev_qch_docs
turn doc installation into an explicit target otherwise a "make install" without a prior "make docs" will fail. we cannot make install depend on docs, because the docs target does not (and cannot reasonably) have proper dependency tracking, so it would be rebuilt on every install attempt. we could make install depend on the presence of the docs files without checking their timestamps, but that would be dirty. Task-number: QTCREATORBUG-6245 Change-Id: I35a9b8110f8f12760a338b5b100d69e226d3c2e8 Reviewed-by: Daniel Molkentin <daniel.molkentin@nokia.com>
2011-11-14 12:02:06 +01:00
install_docs.depends = install_inst_qch_docs install_inst_dev_qch_docs
QMAKE_EXTRA_TARGETS += install_docs
Fixes: make install workd Details: Make install works now, we just have to agree on layout details and check for mac compatibility. Also, plugins will carry no version in their filename anymore starting with this commit. Versioning happens in the creators pluginloader using the pluginspec file.
2009-01-20 14:58:10 +01:00
}
integrate developer docs into the normal docs build Change-Id: Ie94fe37f9025643c35c14a224661295e6c4c9a41 Reviewed-on: http://codereview.qt.nokia.com/288 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Daniel Teske <daniel.teske@nokia.com>
2011-05-31 17:13:23 +02:00
docs_online.depends = html_docs_online dev_html_docs_online
docs.depends = qch_docs dev_qch_docs
QMAKE_EXTRA_TARGETS += html_docs dev_html_docs html_docs_online dev_html_docs_online qch_docs dev_qch_docs docs docs_online
Initial import
2008-12-02 12:01:29 +01:00
use DISTFILES instead of OTHER_FILES in creator's own build system it's the correct variable to use. Change-Id: I9ec7795099097715a64969516cd3fae9e213a0f4 Reviewed-by: Daniel Teske <daniel.teske@digia.com>
2014-09-12 14:34:28 +02:00
DISTFILES = $$HELP_DEP_FILES $$DEV_HELP_DEP_FILES
add fixnavi target for convenience
2010-12-08 16:01:31 +01:00
fixnavi.commands = \
Remove Qt version checks. Qt 5.3 is the minimum requirement these days. Remove all fallback code from sources and project files. Change-Id: If6188a471197acadda4d6baee71804ba1a8026c6 Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2014-08-29 13:18:41 +02:00
cd $$shell_path($$PWD) && \
adjust fixnavi target to new source structure Change-Id: I535ea5632492d1baeabe1a0a8be571d7fe9baba9 Reviewed-by: hjk <qthjk@ovi.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@nokia.com>
2011-11-08 17:44:31 +01:00
perl fixnavi.pl -Dqcmanual -Dqtquick src
add fixnavi target for convenience
2010-12-08 16:01:31 +01:00
QMAKE_EXTRA_TARGETS += fixnavi
Copy Permalink