Group

Groups files in a product. More...

• List of all members, including inherited members
• Group is part of List of All Items.

Properties

• condition : bool
• excludeFiles : pathList
• fileTags : stringList
• fileTagsFilter : stringList
• files : pathList
• filesAreTargets : bool
• name : string
• overrideTags : bool
• prefix : string

Detailed Description

This item is attached to a product and used to group files that have something in common.

For example:

Application {
    Group {
        name: "common files"
        files: ["myclass.h", "myclass_common_impl.cpp"]
    }
    Group {
        name: "Windows files"
        condition: qbs.targetOS.includes("windows")
        files: "myclass_win_impl.cpp"
    }
    Group {
        name: "Unix files"
        condition: qbs.targetOS.includes("unix")
        files: "unixhelper.cpp"
        Group {
            name: "Linux files"
            condition: qbs.targetOS.includes("linux")
            files: "myclass_linux_impl.cpp"
        }
        Group {
            name: "FreeBSD files"
            condition: qbs.targetOS.includes("freebsd")
            files: "myclass_freebsd_impl.cpp"
        }
    }
    Group {
        name: "Files to install"
        qbs.install: true
        qbs.installDir: "share"
        files: "runtime_resource.txt"
    }
}

When specifying files, you can use the wildcards "*", "?" and "[]", which have their usual meaning as in Unix Shell. By default, matching files are only picked up directly from the parent directory, but you can tell Qbs to consider the whole directory tree. It is also possible to exclude certain files from the list. The pattern "**" used in a pathname expansion context will match all files and zero or more directories and subdirectories. For example:

        Group {
            name: "Word processing documents"
            files: ["*.doc", "*.rtf"]
            prefix: "**/"
            qbs.install: true
            qbs.installDir: "share"
            excludeFiles: "do_not_install_this_file.*"
        }

A group can also be used to attach properties to build artifacts such as executables or libraries. In the following example, an application is installed to "<install root>/bin".

Application {
    Group {
        fileTagsFilter: "application"
        qbs.install: true
        qbs.installDir: "bin"
    }
}

Groups may also appear in modules, which causes the respective sources to be added to the products depending on the said module, unless the filesAreTargets property is set.

Groups can be nested. In this case, child groups inherit the module properties and file tags as well as the prefix of their parent group. The condition of a child group gets logically ANDed with the one of its parent group.

Property Documentation

FileTagger JobLimit