aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChristian Kandeler <christian.kandeler@qt.io>2018-06-22 10:24:11 +0200
committerChristian Kandeler <christian.kandeler@qt.io>2018-06-22 10:24:11 +0200
commite86aea00dbf4c0c2deb127aa93276607e7a51909 (patch)
treeaad005de63de140e9a0bfc76f8e4aa040834bb74 /doc
parente0efb1d2b09b7979162f4933193b1a247e393814 (diff)
parent29420ab4698ad45de994cf367b94f23ddc874200 (diff)
Merge 1.12 into master
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/cli/builtin/cli-build.qdoc2
-rw-r--r--doc/reference/cli/builtin/cli-clean.qdoc2
-rw-r--r--doc/reference/cli/builtin/cli-dump-nodes-tree.qdoc2
-rw-r--r--doc/reference/cli/builtin/cli-generate.qdoc2
-rw-r--r--doc/reference/cli/builtin/cli-install.qdoc2
-rw-r--r--doc/reference/cli/builtin/cli-list-products.qdoc63
-rw-r--r--doc/reference/cli/builtin/cli-resolve.qdoc2
-rw-r--r--doc/reference/cli/builtin/cli-run.qdoc2
-rw-r--r--doc/reference/cli/builtin/cli-shell.qdoc2
-rw-r--r--doc/reference/cli/builtin/cli-status.qdoc2
-rw-r--r--doc/reference/cli/builtin/cli-update-timestamps.qdoc2
-rw-r--r--doc/reference/cli/cli-parameters.qdocinc2
12 files changed, 74 insertions, 11 deletions
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-list-products.qdoc b/doc/reference/cli/builtin/cli-list-products.qdoc
new file mode 100644
index 000000000..92ef043da
--- /dev/null
+++ b/doc/reference/cli/builtin/cli-list-products.qdoc
@@ -0,0 +1,63 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qbs.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \contentspage cli.html
+ \page cli-list-products.html
+ \ingroup cli
+
+ \title list-products
+ \brief Lists all products in the given project.
+
+ \section1 Synopsis
+
+ \code
+ qbs list-products [options] [config:configuration-name]
+ \endcode
+
+ \section1 Description
+
+ Lists all products that exist in a project.
+
+ \section1 Options
+
+ \include cli-options.qdocinc project-file
+ \include cli-options.qdocinc build-directory
+ \include cli-options.qdocinc settings-dir
+
+ \section1 Parameters
+
+ \include cli-parameters.qdocinc configuration-name
+
+ \section1 Examples
+
+ To list all products for the project in the current directory:
+
+ \code
+ qbs list-products
+ \endcode
+*/
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] ... [ -- <arguments>]
+ qbs run [options] [config:configuration-name] [property:value] ... [ -- <arguments>]
\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.