aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/cli/builtin/cli-resolve.qdoc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2017-10-04 15:12:48 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2017-10-04 16:03:38 +0000
commit06f2fb7929dd3b3a436cf266b461cef23a6a2f09 (patch)
treece5fd05b45c2257d354913485850f59764d826f7 /doc/reference/cli/builtin/cli-resolve.qdoc
parent8d0b530cf1b8872d4c5bcc315d98f8997f00d46c (diff)
Doc: Create a CLI reference
Each command is described on a separate page. Option and parameter descriptions are fetched from include files. \group and \ingroup commands are used to create a table that shows the CLI commands and short descriptions (from \brief commands). Task-number: QBS-947 Change-Id: I956c0e029f87e98162e03206a79baef604f1d55e Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Diffstat (limited to 'doc/reference/cli/builtin/cli-resolve.qdoc')
-rw-r--r--doc/reference/cli/builtin/cli-resolve.qdoc73
1 files changed, 73 insertions, 0 deletions
diff --git a/doc/reference/cli/builtin/cli-resolve.qdoc b/doc/reference/cli/builtin/cli-resolve.qdoc
new file mode 100644
index 000000000..fd2035f57
--- /dev/null
+++ b/doc/reference/cli/builtin/cli-resolve.qdoc
@@ -0,0 +1,73 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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-resolve.html
+ \ingroup cli
+
+ \title resolve
+ \brief Resolves a project without building it.
+
+ \section1 Synopsis
+
+ \code
+ qbs resolve [options] [[configuration-name] [property:value] ...]
+ \endcode
+
+ \section1 Description
+
+ Resolves a \l{Project Item}{project} in one or more configurations. Run this
+ command to change the properties of an existing build.
+
+ \section1 Options
+
+ \include cli-options.qdocinc build-directory
+ \include cli-options.qdocinc dry-run
+ \include cli-options.qdocinc project-file
+ \include cli-options.qdocinc force-probe-execution
+ \include cli-options.qdocinc jobs
+ \include cli-options.qdocinc less-verbose
+ \include cli-options.qdocinc log-level
+ \include cli-options.qdocinc log-time
+ \include cli-options.qdocinc more-verbose
+ \include cli-options.qdocinc settings-dir
+ \include cli-options.qdocinc show-progress
+
+ \section1 Parameters
+
+ \include cli-parameters.qdocinc configuration-name
+ \include cli-parameters.qdocinc property
+
+ \section1 Examples
+
+ Resolves the default configuration of the project in the current directory:
+
+ \code
+ qbs resolve
+ \endcode
+*/