Qbs Manual | Project Item

Qbs 1.9.0

Product Item ◦ Properties Item

# Project Item

A `Project` item represents a collection of of products. In a non-trivial project, these products are typically defined in their own files and referenced in the main project file:

      Project {
          references: [
              "product1/product1.qbs",
              "product2/product2.qbs"
          ]
      }

Any property `prop` attached to this item is available in sub-items as `project.prop`.

While the root of the item hierarchy is always a `Project`, this kind of item can also appear further down the hierarchy. Such sub-projects are ususally introduced to group products. See the SubProject Item for details.

Note: If your project consists of only one product, the `Project` item can be omitted.

## Project Properties

Property | Type | Default | Description
--- | --- | --- | ---
buildDirectory | path | n/a | The build directory of the top-level project. This property is read-only.
name | string | basename of the file the project is defined in | The project name. Only relevant for e.g. displaying a project tree in an IDE.
profile | string | n/a | The top-level profile for building the project. This property is read-only and is set by Qbs when the project is being set up.
condition | bool | true | Whether the project is enabled. If false, no products or sub-projects will be collected.
qbsSearchPaths | stringList | empty | These paths are searched for imports and modules in addition to the ones listed in `preferences.qbsSearchPaths`. The value set here is merged with the value inherited from the parent project, if there is one. The result is inherited by all products in the project.
references | path list | empty | A list of files from which to import products. This is equivalent to defining the respective `Product` items directly under this `Project` item.
sourceDirectory | path | n/a | The directory where the file containing the top-level `Project` item is located. This property is read-only.
minimumQbsVersion | string | "1.3.0" | The minimum version of qbs that is needed to build this project.

Product Item ◦ Properties Item