Qbs (build tool)

Qbs (pronounced Cubes) is a cross-platform free and open-source software for managing the build process of software. It was designed to support large, complex projects, written in any number of programming languages, primarily C/C++.

Qbs

Developer(s)	Qt Project
Initial release	February 15, 2012 (2012-02-15)
Stable release	1.22.1 / April 29, 2022 (2022-04-29)
Repository	www.code.qt.io/cgit/qbs/qbs.git
Written in	C++, JavaScript, QML, some Java and TypeScript
Operating system	Cross-platform
Type	Build automation, software development tools
License	LGPL
Website	wiki.qt.io/Qbs

Qbs is an all-in-one tool that generates a build graph from a high-level project description (like its predecessor qmake), and additionally undertakes the task of executing the commands in the low-level build graph (like make).

Qbs was originally created by Nokia, then The Qt Company, who distributes it along with their Qt toolkit. It integrates with the Qt framework, and automates the creation of moc (meta object compiler) and rcc (resource compiler) sources, which are used in Qt's meta-object system and in the integration of binary resources (e.g. pictures).

It has been deprecated by Qt Group in 2018 to redirect the resources to CMake instead "Deprecation of Qbs"..

Features

Qbs is unique in that it has no mechanism for in-source builds, guaranteeing the ability to create several builds from a single source tree, including building them from a single command invocation and in parallel. This is a key feature, ensuring that source files remain unaffected if a build directory is removed and that no output artifacts are written into the source directory.

Qbs has no built-in support for any particular programming language, toolkit, or library. This is again in contrast to qmake, which hardcodes support for many Qt-related tools and workflows. Instead, Qbs is provided with a set of modules written in a QML dialect and JavaScript that enable support for a variety of programming languages and tools. Qbs currently provides modules supporting the Android SDK and NDK, C, C++, Java, NSIS, TypeScript, WiX, Xcode, and a variety of other tools.

Qbs can build projects for many platforms including Android, FreeBSD, iOS, Linux, macOS, QNX, tvOS, watchOS, and Windows, with support for Universal Windows Platform applications, INTEGRITY, VxWorks, and other platforms under development.

Qt Creator provides built-in Qbs support, and IDE integration for Visual Studio is provided by the generators feature. Support for Xcode is currently under development.

Build process

The build process in Qbs takes place in two stages. First, the build graph is resolved by reading the project's configuration files and computing the set of input and output nodes and the dependencies between them in a directed acyclic graph. Then the executor executes all of the commands necessary to create the output files, in parallel according to the dependency rules.

Each build project contains a single build graph (*.bg) file in the directory where Qbs stores the serialized representation of its internal build graph format. Deserializing this file and utilizing the cached information allows Qbs to very quickly resolve the project, leading to near-instant incremental builds. Deleting the build graph file causes a complete (clean) rebuild of the entire project. In contrast to make, Qbs does not rely on timestamps of files in the build directory, and tampering with its contents will not lead to targets being rebuilt unless the --check-outputs option is used. This is done for performance reasons because on some platforms (e.g. Windows), reading timestamps from the filesystem is very slow compared to reading them from the build graph file.

Example Qbs file

CppApplication {
    name: "helloworld"
    files: "main.cpp"
}

History

Qbs development began at Nokia in the year 2010 in response to the need for a replacement for qmake. Qbs' design aims to provide a much lower learning curve, better integration with IDEs, and a stable and powerful language with predictable behavior. Qbs 1.0 was released in 2013 and further developed by the Qt Company beginning around that time under the governance model of the Qt Project. The developers hoped to eventually push for Qbs to replace qmake as Qt's own build system. However, in October 2018 it was deprecated in favor of qmake and/or cmake. In an August 7, 2019 blog post, the Qt Company stated that starting with Qt 6, cmake will become Qt's standard build system and cited cmake's extreme popularity as a factor.

Qbs development was taken over by external volunteers, who as of June 2020 are still actively maintaining it under the Qt Project umbrella. Although the Qt Company announced that they would stop further development on Qbs, they committed to provide the necessary infrastructure for future releases of Qbs by the community.

Applications that use Qbs

• Qt Creator

Further reading

• Uzayr, Sufyan bin (11 November 2022). Mastering KDE: A Beginner's Guide. CRC Press. ISBN 978-1-000-77589-1.

External links

• Qbs Manual