aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChristian Kandeler <christian.kandeler@digia.com>2013-11-06 12:14:06 +0100
committerChristian Kandeler <christian.kandeler@digia.com>2013-11-06 12:16:37 +0100
commit2d80d68db948bea027a6e0d9a9e289f112c5dd6e (patch)
tree816aa3e9bcfba960265938ff2ba2584c6e4b8131 /doc
parent896b90a06a692702e7e5c5da148bdac835c97b6d (diff)
parentdb11fbfc994272c965f62effeb5b464741234ab6 (diff)
Merge branch '1.1' into 'master'.
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/items/artifact.qdoc68
-rw-r--r--doc/reference/items/depends.qdoc67
-rw-r--r--doc/reference/items/export.qdoc1
-rw-r--r--doc/reference/items/module.qdoc2
-rw-r--r--doc/reference/items/probe.qdoc69
-rw-r--r--doc/reference/items/product.qdoc8
-rw-r--r--doc/reference/items/project.qdoc4
-rw-r--r--doc/reference/items/properties.qdoc4
-rw-r--r--doc/reference/items/propertyoptions.qdoc69
-rw-r--r--doc/reference/items/rule.qdoc9
-rw-r--r--doc/reference/items/subproject.qdoc4
-rw-r--r--doc/reference/items/transformer.qdoc2
-rw-r--r--doc/reference/jsextensions/jsextensions-general.qdoc57
13 files changed, 353 insertions, 11 deletions
diff --git a/doc/reference/items/artifact.qdoc b/doc/reference/items/artifact.qdoc
new file mode 100644
index 000000000..f136e2201
--- /dev/null
+++ b/doc/reference/items/artifact.qdoc
@@ -0,0 +1,68 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2013 Petroules Corporation.
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Build Suite.
+**
+** 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 Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights. These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+/*!
+ \contentspage list-of-items.html
+ \page artifact-item.html
+ \nextpage depends-item.html
+ \ingroup list-of-items
+
+ \title Artifact Item
+ \brief Describes a file produced by a \c Rule or \c Transformer.
+
+ An \c Artifact represents a single file produced by a \c Rule or \c Transformer.
+
+ For example, if a rule produces three files, it needs to contain three Artifact items.
+
+ \section1 Artifact Properties
+
+ \table
+ \header
+ \li Property
+ \li Type
+ \li Default
+ \li Description
+ \row
+ \li condition
+ \li bool
+ \li true
+ \li Determines whether the target file will actually be produced.
+ \row
+ \li fileName
+ \li string
+ \li undefined
+ \li The file path of the target artifact.
+ \row
+ \li fileTags
+ \li list
+ \li empty list
+ \li The tags to attach to the target file. These can then be matched by a rule.
+ \endtable
+
+*/
diff --git a/doc/reference/items/depends.qdoc b/doc/reference/items/depends.qdoc
new file mode 100644
index 000000000..2e60eed47
--- /dev/null
+++ b/doc/reference/items/depends.qdoc
@@ -0,0 +1,67 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2013 Petroules Corporation.
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Build Suite.
+**
+** 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 Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights. These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+/*!
+ \contentspage list-of-items.html
+ \previouspage artifact-item.html
+ \page depends-item.html
+ \nextpage export-item.html
+ \ingroup list-of-items
+
+ \title Depends Item
+ \brief Represents dependencies between between products and modules.
+
+ A \c Depends item can appear inside a \l{Product Item} or \l{Module Item}.
+
+ \section1 Depends Properties
+
+ \table
+ \header
+ \li Property
+ \li Type
+ \li Default
+ \li Description
+ \row
+ \li condition
+ \li bool
+ \li true
+ \li Determines whether the dependency will actually be applied.
+ \row
+ \li name
+ \li string
+ \li undefined
+ \li The name of the dependent product or module.
+ \row
+ \li submodules
+ \li stringList
+ \li undefined
+ \li The submodules of \c module to depend on, if applicable.
+ \endtable
+
+*/
diff --git a/doc/reference/items/export.qdoc b/doc/reference/items/export.qdoc
index 7e3f46b88..2c714c129 100644
--- a/doc/reference/items/export.qdoc
+++ b/doc/reference/items/export.qdoc
@@ -28,6 +28,7 @@
****************************************************************************/
/*!
\contentspage list-of-items.html
+ \previouspage depends-item.html
\page export-item.html
\nextpage filetagger-item.html
\ingroup list-of-items
diff --git a/doc/reference/items/module.qdoc b/doc/reference/items/module.qdoc
index 864ce2b97..5a28266b4 100644
--- a/doc/reference/items/module.qdoc
+++ b/doc/reference/items/module.qdoc
@@ -30,7 +30,7 @@
\contentspage list-of-items.html
\previouspage group-item.html
\page module-item.html
- \nextpage product-item.html
+ \nextpage probe-item.html
\ingroup list-of-items
\title Module Item
diff --git a/doc/reference/items/probe.qdoc b/doc/reference/items/probe.qdoc
new file mode 100644
index 000000000..17fdfac42
--- /dev/null
+++ b/doc/reference/items/probe.qdoc
@@ -0,0 +1,69 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2013 Petroules Corporation.
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Build Suite.
+**
+** 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 Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights. These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+/*!
+ \contentspage list-of-items.html
+ \previouspage module-item.html
+ \page probe-item.html
+ \nextpage product-item.html
+ \ingroup list-of-items
+
+ \title Probe Item
+ \brief Locates files outside the project.
+
+ A \c Probe item can appear inside a \l{Product Item} and is run prior to building products in
+ order to locate dependent headers, libraries, and other files outside the project directory
+ whose locations are not known ahead of time. \c Probes are similar to configure scripts.
+
+ \section1 Probe Properties
+
+ \table
+ \header
+ \li Property
+ \li Type
+ \li Default
+ \li Description
+ \row
+ \li condition
+ \li bool
+ \li true
+ \li Determines whether the probe will actually be run.
+ \row
+ \li found
+ \li bool
+ \li undefined
+ \li Indicates whether the probe was run successfully. Set by \c configure.
+ \row
+ \li configure
+ \li script
+ \li undefined
+ \li Script that is executed when the probe is run.
+ \endtable
+
+*/
diff --git a/doc/reference/items/product.qdoc b/doc/reference/items/product.qdoc
index 8015f0269..f5203f70c 100644
--- a/doc/reference/items/product.qdoc
+++ b/doc/reference/items/product.qdoc
@@ -28,7 +28,7 @@
****************************************************************************/
/*!
\contentspage list-of-items.html
- \previouspage module-item.html
+ \previouspage probe-item.html
\page product-item.html
\nextpage project-item.html
\ingroup list-of-items
@@ -124,6 +124,12 @@
\li See the documentation of the \l {Project Item} property of the same name.
Setting this property here will overwrite the default value inherited from
the project, so use the \c concat() function if you want to add something.
+ \row
+ \li version
+ \li string
+ \li undefined
+ \li The version number of the product. Used in shared library filenames and generated
+ Info.plist files in OS X and iOS application and framework bundles, for example.
\endtable
The following properties are automatically set by qbs and usually are not changed by the user:
diff --git a/doc/reference/items/project.qdoc b/doc/reference/items/project.qdoc
index 5d8ca35cc..e05bc37f2 100644
--- a/doc/reference/items/project.qdoc
+++ b/doc/reference/items/project.qdoc
@@ -30,7 +30,7 @@
\contentspage list-of-items.html
\previouspage product-item.html
\page project-item.html
- \nextpage subproject-item.html
+ \nextpage properties-item.html
\ingroup list-of-items
\title Project Item
@@ -77,7 +77,7 @@
\li stringList
\li empty
\li These paths are searched for imports and modules in addition to the ones listed
- in \c{preferences.qbsPath}.
+ in \c{preferences.qbsSearchPaths}.
All products in the project inherit this value by default.
\row
\li references
diff --git a/doc/reference/items/properties.qdoc b/doc/reference/items/properties.qdoc
index ba3f0ae06..c10134e9e 100644
--- a/doc/reference/items/properties.qdoc
+++ b/doc/reference/items/properties.qdoc
@@ -28,9 +28,9 @@
****************************************************************************/
/*!
\contentspage list-of-items.html
- \previouspage subproject-item.html
+ \previouspage project-item.html
\page properties-item.html
- \nextpage rule-item.html
+ \nextpage propertyoptions-item.html
\ingroup list-of-items
\title Properties Item
diff --git a/doc/reference/items/propertyoptions.qdoc b/doc/reference/items/propertyoptions.qdoc
new file mode 100644
index 000000000..5dbb94df8
--- /dev/null
+++ b/doc/reference/items/propertyoptions.qdoc
@@ -0,0 +1,69 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2013 Petroules Corporation.
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Build Suite.
+**
+** 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 Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights. These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+/*!
+ \contentspage list-of-items.html
+ \previouspage properties-item.html
+ \page propertyoptions-item.html
+ \nextpage rule-item.html
+ \ingroup list-of-items
+
+ \title PropertyOptions Item
+ \brief Provides inline documentation for properties within product and module items.
+
+ A \c PropertyOptions item can appear inside a \l{Product Item} or \l{Module Item} to provide
+ inline documentation for properties.
+
+ \section1 PropertyOptions Properties
+
+ \table
+ \header
+ \li Property
+ \li Type
+ \li Default
+ \li Description
+ \row
+ \li allowedValues
+ \li stringList
+ \li undefined
+ \li A list of the values permitted by the property. \c{undefined} indicates that any value
+ is permitted.
+ \row
+ \li description
+ \li string
+ \li undefined
+ \li A brief description of the property.
+ \row
+ \li name
+ \li string
+ \li undefined
+ \li The name of the property to document.
+ \endtable
+
+*/
diff --git a/doc/reference/items/rule.qdoc b/doc/reference/items/rule.qdoc
index 56244ced6..aca2acbb9 100644
--- a/doc/reference/items/rule.qdoc
+++ b/doc/reference/items/rule.qdoc
@@ -28,9 +28,9 @@
****************************************************************************/
/*!
\contentspage list-of-items.html
- \previouspage properties-item.html
+ \previouspage propertyoptions-item.html
\page rule-item.html
- \nextpage transformer-item.html
+ \nextpage subproject-item.html
\ingroup list-of-items
\title Rule Item
@@ -131,6 +131,11 @@
script. Also, each output artifact of this rule will be dependent on
those artifacts.
\row
+ \li condition
+ \li bool
+ \li true
+ \li If true, the rule is enabled, otherwise it does nothing.
+ \row
\li explicitlyDependsOn
\li string list
\li undefined
diff --git a/doc/reference/items/subproject.qdoc b/doc/reference/items/subproject.qdoc
index 64aaa86fe..c89807ded 100644
--- a/doc/reference/items/subproject.qdoc
+++ b/doc/reference/items/subproject.qdoc
@@ -28,9 +28,9 @@
****************************************************************************/
/*!
\contentspage list-of-items.html
- \previouspage project-item.html
+ \previouspage rule-item.html
\page subproject-item.html
- \nextpage properties-item.html
+ \nextpage transformer-item.html
\ingroup list-of-items
\title SubProject Item
diff --git a/doc/reference/items/transformer.qdoc b/doc/reference/items/transformer.qdoc
index 4320a2cb4..17939d80f 100644
--- a/doc/reference/items/transformer.qdoc
+++ b/doc/reference/items/transformer.qdoc
@@ -28,7 +28,7 @@
****************************************************************************/
/*!
\contentspage list-of-items.html
- \previouspage rule-item.html
+ \previouspage subproject-item.html
\page transformer-item.html
\ingroup list-of-items
diff --git a/doc/reference/jsextensions/jsextensions-general.qdoc b/doc/reference/jsextensions/jsextensions-general.qdoc
new file mode 100644
index 000000000..d503f6c8c
--- /dev/null
+++ b/doc/reference/jsextensions/jsextensions-general.qdoc
@@ -0,0 +1,57 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Build Suite.
+**
+** 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 Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights. These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+/*!
+ \contentspage index.html
+ \page jsextensions-general.html
+ \ingroup list-of-builtin-services
+
+ \title General Services
+ \brief Provides various operations.
+
+ These are operations that do not fit into any of the other categories.
+ They are automatically available in any qbs project file.
+
+ \section1 Available Operations
+
+ \section2 getenv
+ \code
+ qbs.getenv(name)
+ \endcode
+ Tries to find a variable with the given name in the build environment and returns its value. If
+ no such variable could be found, \c undefined is returned.
+
+ \section2 getHostOS
+ \code
+ qbs.getHostOS(name)
+ \endcode
+ Returns the name of the operating system on which qbs is running.
+ \note Do not confuse this with the \c{qbs.targetOS} property, which represents the operating
+ system on which the binaries produced by qbs will run.
+*/