Chapter 8. Script files

Buildtool modules are controlled through several different script files. These files contain function definitions; code must not be placed outside these predefined functions to avoid unexpected side effects. The following files are recognized:

Config.bt

Located at the top level directory of your project. This is the automatic configuration script. See Chapter 11, The configuration script. The use of this file is discouraged; instead write a config function inside Generic.bt.

Defs.bt

Located at the top level directory of your project. Specifies several basic details of your project. See Chapter 9, The definitions script. The use of this file is discouraged; instead write a defs function inside Generic.bt.

Docs.bt

Located at the top level directory of your project. The documentation file used by the bt_doc module. See Chapter 10, The documentation script. The use of this file is discouraged; instead write a docs function inside Generic.bt.

Generic.bt

Located at the top level directory of your project. It can be used to control all modules from a single file, thus keeping build information centralized. Ideally, you should only use this one.

Logic.bt

Located in each directory of your project. This controls the build process of all targets in your package. The use of this file in the top directory of your project is discouraged; instead write a logic function inside Generic.bt. For all other directories, only the Logic.bt file is recognized.