From 30fb7a1a2b9ea655bf974ea5a937f045940ac082 Mon Sep 17 00:00:00 2001 From: Christian Kandeler Date: Fri, 15 Jun 2018 14:18:30 +0200 Subject: Fix CLI documentation Adapt to the change in how to specify the build configuration name. Change-Id: Ia339d3c991e7b9f82b23ed7f40c5eea19f003dd1 Reviewed-by: Leena Miettinen --- doc/reference/cli/builtin/cli-build.qdoc | 2 +- doc/reference/cli/builtin/cli-clean.qdoc | 2 +- doc/reference/cli/builtin/cli-dump-nodes-tree.qdoc | 2 +- doc/reference/cli/builtin/cli-generate.qdoc | 2 +- doc/reference/cli/builtin/cli-install.qdoc | 2 +- doc/reference/cli/builtin/cli-resolve.qdoc | 2 +- doc/reference/cli/builtin/cli-run.qdoc | 2 +- doc/reference/cli/builtin/cli-shell.qdoc | 2 +- doc/reference/cli/builtin/cli-status.qdoc | 2 +- doc/reference/cli/builtin/cli-update-timestamps.qdoc | 2 +- doc/reference/cli/cli-parameters.qdocinc | 2 +- 11 files changed, 11 insertions(+), 11 deletions(-) (limited to 'doc') diff --git a/doc/reference/cli/builtin/cli-build.qdoc b/doc/reference/cli/builtin/cli-build.qdoc index cc5f4b27f..8e4b8ed44 100644 --- a/doc/reference/cli/builtin/cli-build.qdoc +++ b/doc/reference/cli/builtin/cli-build.qdoc @@ -36,7 +36,7 @@ \section1 Synopsis \code - qbs build [options] [[configuration-name] [property:value] ...] + qbs build [options] [[config:configuration-name] [property:value] ...] \endcode \section1 Description diff --git a/doc/reference/cli/builtin/cli-clean.qdoc b/doc/reference/cli/builtin/cli-clean.qdoc index f87270825..bd6ba1616 100644 --- a/doc/reference/cli/builtin/cli-clean.qdoc +++ b/doc/reference/cli/builtin/cli-clean.qdoc @@ -36,7 +36,7 @@ \section1 Synopsis \code - qbs clean [options] [configuration-name] + qbs clean [options] [config:configuration-name] \endcode \section1 Description diff --git a/doc/reference/cli/builtin/cli-dump-nodes-tree.qdoc b/doc/reference/cli/builtin/cli-dump-nodes-tree.qdoc index 1f3e061c4..2e5485ec2 100644 --- a/doc/reference/cli/builtin/cli-dump-nodes-tree.qdoc +++ b/doc/reference/cli/builtin/cli-dump-nodes-tree.qdoc @@ -36,7 +36,7 @@ \section1 Synopsis \code - qbs dump-nodes-tree [options] [configuration-name] + qbs dump-nodes-tree [options] [config:configuration-name] \endcode \section1 Description diff --git a/doc/reference/cli/builtin/cli-generate.qdoc b/doc/reference/cli/builtin/cli-generate.qdoc index ec85813f0..b6dda6f4f 100644 --- a/doc/reference/cli/builtin/cli-generate.qdoc +++ b/doc/reference/cli/builtin/cli-generate.qdoc @@ -37,7 +37,7 @@ \section1 Synopsis \code - qbs generate [options] [[configuration-name] [property:value] ...] + qbs generate [options] [[config:configuration-name] [property:value] ...] \endcode \section1 Description diff --git a/doc/reference/cli/builtin/cli-install.qdoc b/doc/reference/cli/builtin/cli-install.qdoc index 3bddc4fcd..b55f05296 100644 --- a/doc/reference/cli/builtin/cli-install.qdoc +++ b/doc/reference/cli/builtin/cli-install.qdoc @@ -36,7 +36,7 @@ \section1 Synopsis \code - qbs install [options] [[configuration-name] [property:value] ...] + qbs install [options] [[config:configuration-name] [property:value] ...] \endcode \section1 Description diff --git a/doc/reference/cli/builtin/cli-resolve.qdoc b/doc/reference/cli/builtin/cli-resolve.qdoc index 1743eb55f..7170856f2 100644 --- a/doc/reference/cli/builtin/cli-resolve.qdoc +++ b/doc/reference/cli/builtin/cli-resolve.qdoc @@ -36,7 +36,7 @@ \section1 Synopsis \code - qbs resolve [options] [[configuration-name] [property:value] ...] + qbs resolve [options] [[config:configuration-name] [property:value] ...] \endcode \section1 Description diff --git a/doc/reference/cli/builtin/cli-run.qdoc b/doc/reference/cli/builtin/cli-run.qdoc index 42bc8d4f9..9f20f868e 100644 --- a/doc/reference/cli/builtin/cli-run.qdoc +++ b/doc/reference/cli/builtin/cli-run.qdoc @@ -36,7 +36,7 @@ \section1 Synopsis \code - qbs run [options] [configuration-name] [property:value] ... [ -- ] + qbs run [options] [config:configuration-name] [property:value] ... [ -- ] \endcode \section1 Description diff --git a/doc/reference/cli/builtin/cli-shell.qdoc b/doc/reference/cli/builtin/cli-shell.qdoc index c1af42e20..221bef24d 100644 --- a/doc/reference/cli/builtin/cli-shell.qdoc +++ b/doc/reference/cli/builtin/cli-shell.qdoc @@ -36,7 +36,7 @@ \section1 Synopsis \code - qbs shell [options] [configuration-name] [property:value] + qbs shell [options] [config:configuration-name] [property:value] \endcode \section1 Description diff --git a/doc/reference/cli/builtin/cli-status.qdoc b/doc/reference/cli/builtin/cli-status.qdoc index a619aa9ce..ddc8537f3 100644 --- a/doc/reference/cli/builtin/cli-status.qdoc +++ b/doc/reference/cli/builtin/cli-status.qdoc @@ -36,7 +36,7 @@ \section1 Synopsis \code - qbs status [options] [configuration-name] + qbs status [options] [config:configuration-name] \endcode \section1 Description diff --git a/doc/reference/cli/builtin/cli-update-timestamps.qdoc b/doc/reference/cli/builtin/cli-update-timestamps.qdoc index 39faddfed..366f1352b 100644 --- a/doc/reference/cli/builtin/cli-update-timestamps.qdoc +++ b/doc/reference/cli/builtin/cli-update-timestamps.qdoc @@ -36,7 +36,7 @@ \section1 Synopsis \code - qbs update-timestamps [options] [configuration-name] ... + qbs update-timestamps [options] [config:configuration-name] ... \endcode \section1 Description diff --git a/doc/reference/cli/cli-parameters.qdocinc b/doc/reference/cli/cli-parameters.qdocinc index eb16f3ff8..70f7a087f 100644 --- a/doc/reference/cli/cli-parameters.qdocinc +++ b/doc/reference/cli/cli-parameters.qdocinc @@ -37,7 +37,7 @@ //! [configuration-name] - \section2 \c configuration-name + \section2 \c config:configuration-name Specifies the build configuration to use. -- cgit v1.2.3