aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/items/language/subproject.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/reference/items/language/subproject.qdoc')
-rw-r--r--doc/reference/items/language/subproject.qdoc75
1 files changed, 75 insertions, 0 deletions
diff --git a/doc/reference/items/language/subproject.qdoc b/doc/reference/items/language/subproject.qdoc
new file mode 100644
index 000000000..644b600aa
--- /dev/null
+++ b/doc/reference/items/language/subproject.qdoc
@@ -0,0 +1,75 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 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 list-of-language-items.html
+ \previouspage scanner-item.html
+ \page subproject-item.html
+ \ingroup list-of-language-items
+ \ingroup list-of-items
+
+ \title SubProject Item
+ \brief Adds a project from a different file.
+
+ A \c SubProject item is used to add a project defined in another file as a sub-project to
+ the surrounding project:
+ \code
+ SubProject {
+ filePath: "subdir/project.qbs"
+ Properties {
+ name: "A sub-project"
+ }
+ }
+ \endcode
+
+ If you don't need to set any properties on the sub-project, you can also use the \c references
+ property, the same way you would do for a product:
+ \code
+ references: "subdir/project.qbs"
+ \endcode
+
+ It is also possible to nest \c Project items directly in the same file.
+
+ \table
+ \header
+ \li Property
+ \li Type
+ \li Default
+ \li Description
+ \row
+ \li filePath
+ \li path
+ \li empty
+ \li The file path of the project to add as a sub-project. If the top-level item in this
+ file is a \c Product, it gets wrapped automatically in a new project.
+ \row
+ \li inheritProperties
+ \li bool
+ \li true
+ \li Whether the sub-project should inherit the properties of the surrounding project.
+ You can use this feature to share "global" settings between (sub-)projects.
+ \endtable
+*/