diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2017-12-22 15:33:15 +0100 |
---|---|---|
committer | Christian Kandeler <christian.kandeler@qt.io> | 2018-01-03 10:44:31 +0000 |
commit | 5ecbff643d5c3977e53da7b2afcf624702e32ffb (patch) | |
tree | 6ae3792e3213d564b0209155b8b2ac5b458e274c | |
parent | 7884bb6c03c8a552372ea0c2f5a1e33826340af1 (diff) |
Doc: Add links to CLI command options
Added targets to the file where the options are documented, to
avoid having to use the weird URLs automatically generated by
QDoc.
Change-Id: I3bffa79b564ffb9582f814124881dcd0cc60aa7d
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
-rw-r--r-- | doc/qbs.qdoc | 7 | ||||
-rw-r--r-- | doc/reference/cli/builtin/cli-build.qdoc | 3 | ||||
-rw-r--r-- | doc/reference/cli/builtin/cli-generate.qdoc | 1 | ||||
-rw-r--r-- | doc/reference/items/language/probe.qdoc | 4 | ||||
-rw-r--r-- | doc/reference/items/language/product.qdoc | 5 |
5 files changed, 13 insertions, 7 deletions
diff --git a/doc/qbs.qdoc b/doc/qbs.qdoc index 95bb3f250..3456401a7 100644 --- a/doc/qbs.qdoc +++ b/doc/qbs.qdoc @@ -1424,7 +1424,7 @@ To generate a project for another build system, such as Microsoft Visual Studio, use the \l{generate}{qbs generate} command and specify a generator - using the \c{-g} option. For example: + using the \l{generate-generator}{-g} option. For example: \code # For Visual Studio @@ -1439,8 +1439,9 @@ perform the actual build. \note You cannot modify build system files and expect the changes - to be reflected in \QBS; you must edit your \QBS project files and re-run \c{qbs-generate} in - order for the changes to be reflected in your IDE. + to be reflected in \QBS. You must edit your \QBS project files and re-run + \l{generate}{qbs generate} in order for the changes to be reflected in your + IDE. \section1 Generating Clang Compilation Databases diff --git a/doc/reference/cli/builtin/cli-build.qdoc b/doc/reference/cli/builtin/cli-build.qdoc index 81b476d37..a61e6601f 100644 --- a/doc/reference/cli/builtin/cli-build.qdoc +++ b/doc/reference/cli/builtin/cli-build.qdoc @@ -55,6 +55,7 @@ \section1 Options + \target build-all-products \include cli-options.qdocinc all-products \include cli-options.qdocinc build-directory \include cli-options.qdocinc changed-files @@ -64,6 +65,7 @@ \include cli-options.qdocinc command-echo-mode \include cli-options.qdocinc dry-run \include cli-options.qdocinc project-file + \target build-force-probe-execution \include cli-options.qdocinc force-probe-execution \include cli-options.qdocinc jobs \include cli-options.qdocinc keep-going @@ -72,6 +74,7 @@ \include cli-options.qdocinc log-time \include cli-options.qdocinc more-verbose \include cli-options.qdocinc no-install + \target build-products \include cli-options.qdocinc products-specified \include cli-options.qdocinc settings-dir \include cli-options.qdocinc show-progress diff --git a/doc/reference/cli/builtin/cli-generate.qdoc b/doc/reference/cli/builtin/cli-generate.qdoc index 3d7d4cdbf..ec85813f0 100644 --- a/doc/reference/cli/builtin/cli-generate.qdoc +++ b/doc/reference/cli/builtin/cli-generate.qdoc @@ -49,6 +49,7 @@ \section1 Options + \target generate-generator \include cli-options.qdocinc generator \include cli-options.qdocinc build-directory \include cli-options.qdocinc project-file diff --git a/doc/reference/items/language/probe.qdoc b/doc/reference/items/language/probe.qdoc index ec1455b8f..7151abf3b 100644 --- a/doc/reference/items/language/probe.qdoc +++ b/doc/reference/items/language/probe.qdoc @@ -57,8 +57,8 @@ \note Because Probes often invoke external processes, which is relatively expensive compared to evaluating normal properties, their results are cached. To force re-evaluation - of a Probe, you can supply the \c{--force-probe-execution} command-line option - to the \l{build} command. + of a Probe, you can supply the \l{build-force-probe-execution} + {--force-probe-execution} command-line option to the \l{build} command. */ /*! diff --git a/doc/reference/items/language/product.qdoc b/doc/reference/items/language/product.qdoc index 82f36adf1..6b87cffc0 100644 --- a/doc/reference/items/language/product.qdoc +++ b/doc/reference/items/language/product.qdoc @@ -99,8 +99,9 @@ Determines whether the product will be built. If \c false, the product will only be built if this is explicitly requested, - either by listing the product name as an argument to \c --products or by - giving the \l{build} command the \c --all-products option. + either by listing the product name as an argument to the + \l{build-products}{--products} option or by using the + \l{build-all-products}{--all-products} option of the \l{build} command. \defaultvalue \c true */ |