waf [commands] [options]
Main commands (example: ./waf build -j4)
bootstrap_library_project : Creates a zip that includes a library project
build : High level definition of the build details
build_all : shortcut to build all variants
build_app_doxygen : executes the build of app_doxygen
build_app_doxygen_unit_test : executes the build of app_doxygen_unit_test
build_app_embedded : executes the build of app_embedded
build_app_host_unit_test : executes the build of app_host_unit_test
build_app_spa : executes the build of app_spa
build_bootloader_doxygen : executes the build of bootloader_doxygen
build_bootloader_doxygen_unit_test: executes the build of bootloader_doxygen_unit_test
build_bootloader_embedded : executes the build of bootloader_embedded
build_bootloader_host_unit_test : executes the build of bootloader_host_unit_test
build_bootloader_spa : executes the build of bootloader_spa
build_docs : executes the build of docs
check_test_files : Check if test files to corresponding source files exist.
clean : cleans the project
clean_all : shortcut to clean all variants
clean_app_doxygen : cleans the project app_doxygen
clean_app_doxygen_unit_test : cleans the project app_doxygen_unit_test
clean_app_embedded : cleans the project app_embedded
clean_app_host_unit_test : cleans the project app_host_unit_test
clean_app_spa : cleans the project app_spa
clean_bootloader_doxygen : cleans the project bootloader_doxygen
clean_bootloader_doxygen_unit_test: cleans the project bootloader_doxygen_unit_test
clean_bootloader_embedded : cleans the project bootloader_embedded
clean_bootloader_host_unit_test : cleans the project bootloader_host_unit_test
clean_bootloader_spa : cleans the project bootloader_spa
clean_docs : cleans the project docs
configure : Configures the project
dist : makes a tarball for redistributing the sources
distcheck : checks if the project compiles (tarball from 'dist')
distclean : removes build folders and data
get_deepest_src_file : Returns the path length of all source files.
list : lists the targets to execute
list_app_embedded : lists the targets to execute for app_embedded
list_app_spa : lists the targets to execute for app_spa
list_bootloader_embedded : lists the targets to execute for bootloader_embedded
list_bootloader_spa : lists the targets to execute for bootloader_spa
step : executes tasks in a step-by-step fashion, for debugging
step_app_embedded : executes tasks in a step-by-step fashion, for debugging of app_embedded
step_app_spa : executes tasks in a step-by-step fashion, for debugging of app_spa
step_bootloader_embedded : executes tasks in a step-by-step fashion, for debugging of bootloader_embedded
step_bootloader_spa : executes tasks in a step-by-step fashion, for debugging of bootloader_spa
version_consistency_checker : checks that all version strings in the repository are synced
Options:
--version show program's version number and exit
-c COLORS, --color=COLORS
whether to use colors (yes/no/auto) [default: auto]
-j JOBS, --jobs=JOBS amount of parallel jobs (12)
-k, --keep continue despite errors (-kk to try harder)
-v, --verbose verbosity level -v -vv or -vvv [default: 0]
--zones=ZONES debugging zones (task_gen, deps, tasks, etc)
-h, --help show this help message and exit
--coverage Builds a coverage report based on the unit test
--cc-options=CC_OPTIONS
Path to cc options specification file
--confcache Use a configuration cache
--lauterbach-installation-directory=LAUTERBACH_BASE
Installation directory of Lauterbach tools
--lauterbach-use-tcp Use TCP as connection for the debugger.
Configuration options:
Build and installation options:
-p, --progress -p: progress bar; -pp: ide output
Step options:
--files=FILES files to process, by regexp, e.g. "*/main.c,*/test/main.o"
Installation and uninstallation options:
--distcheck-args=ARGS
arguments to pass to distcheck
