fab.steps.root_inc_files

A helper step to copy include files to the root of the build source folder, for easy include by the preprocessor.

Functions

root_inc_files(config[, suffix_list])

Copy include files with a specific suffix into the workspace output root.

fab.steps.root_inc_files.root_inc_files(config, suffix_list=None)

Copy include files with a specific suffix into the workspace output root.

Checks for name clash. This step does not create any artefacts, nor does it add a search path. It is up to the user to configure other tools to find these files.

Parameters:

• config (BuildConfig) – The fab.build_config.BuildConfig object where we can read settings such as the project workspace folder or the multiprocessing flag.

• suffix_list (str | List[str] | None) – List of all suffixes to be copied (or a single suffix as string). Note that the . MUST be included (e.g. .h90). Defaults to .inc (default: None)