Scanner

SubProject

Adds a project from a different file. More...

• List of all members, including inherited members

Properties

• condition : bool
• filePath : path
• inheritProperties : bool

Detailed Description

A SubProject item is used to add a sub-project that is defined in a separate file. Additionally, properties of the sub-project can be set without modifying the separate project file.

The following example adds a sub-project defined in subdir/project.qbs and overrides its name.

 Project {
     SubProject {
         filePath: "subdir/project.qbs"
         Properties {
             name: "A sub-project"
         }
     }
     ...
 }

A typical use case for SubProject items is to conditionally include sub-projects. The following example pulls in the tests sub-project if and only if the withTests property is true.

 Project {
     property bool withTests: false
     SubProject {
         filePath: "tests/tests.qbs"
         Properties {
             condition: parent.withTests
         }
     }
     ...
 }

If you do not need to set any properties on the sub-project, you can also use the Project.references property, the same way you would for a product.

 Project {
     references: "subdir/project.qbs"
 }

is equivalent with

 Project {
     SubProject {
         filePath: "subdir/project.qbs"
     }
 }

It is also possible to nest Project items directly in the same file.

Property Documentation

Scanner