csbuild - Man Page
tool for plugging static analyzers into the build process
Description
usage: csbuild [-h] -c BUILD_CMD [-g GIT_COMMIT_RANGE] [--git-bisect]
[--added-exit-code ADDED_EXIT_CODE] [--base-fail-exit-code BASE_FAIL_EXIT_CODE] [--print-current] [--no-print-current] [--print-added] [--no-print-added] [--print-fixed] [--no-print-fixed] [--clean] [--no-clean] [--cswrap-timeout CSWRAP_TIMEOUT] [--color] [--no-color] [--gen-travis-yml] [--install INSTALL] [--prep-cmd PREP_CMD] [--build-dir BUILD_DIR] [-w GCC_WARNING_LEVEL] [--gcc-add-flag GCC_ADD_FLAG] [--gcc-add-c-only-flag GCC_ADD_C_ONLY_FLAG] [--gcc-add-cxx-only-flag GCC_ADD_CXX_ONLY_FLAG] [--gcc-del-flag GCC_DEL_FLAG] [--clang-add-flag CLANG_ADD_FLAG] [-U EMBED_CONTEXT] [--version]
options
- -h, --help
show this help message and exit
- -c, --build-cmd BUILD_CMD
Shell command used to build the sources. It runs in @BUILDDIR@ (which defaults to $PWD if --build-dir is not specified). @SRCDIR@ expands to $PWD at the time of csbuild's invocation.
- -g, --git-commit-range GIT_COMMIT_RANGE
range of git revisions for a differential scan in format OLD_REV..NEW_REV
- --git-bisect
if a new defect is added, use git-bisect to identify the cause WARNING: The given command must (re)compile all sources for this option to work!
- --added-exit-code ADDED_EXIT_CODE
exit code to return if there is any defect added in the new version (default: 7)
- --base-fail-exit-code BASE_FAIL_EXIT_CODE
exit code to return if the base scan fails (default: 0)
- --print-current
print all defects in the current version (default unless -g is given) WARNING: The given command must (re)compile all sources for this option to work!
- --no-print-current
disables --print-current
- --print-added
print defects added in the new version (default if -g is given)
- --no-print-added
disables --print-added
- --print-fixed
print defects fixed in the new version WARNING: The given command must (re)compile all sources for this option to work!
- --no-print-fixed
disables --print-fixed
- --clean
clean the temporary directory with results (and @BUILDDIR@) on exit (default)
- --no-clean
disables --clean
- --cswrap-timeout CSWRAP_TIMEOUT
maximal amount of time in seconds taken by analysis of a single module (default: 30)
- --color
use colorized console output (default if connected to a tty)
- --no-color
disables --color
- --gen-travis-yml
generate the .travis.yml file for Travis CI (requires --install)
- --install INSTALL
space-separated list of packages to install with --gen-travis-yml
- --prep-cmd PREP_CMD
Shell command to run before the build. It runs in @BUILDDIR@ (which defaults to $PWD if --build-dir is not specified). @SRCDIR@ expands to $PWD at the time of csbuild's invocation.
- --build-dir BUILD_DIR
Directory to be created to run the prep and build commands in (optional). If not specified, the commands run in $PWD. @BUILDDIR@ in the operand of --build-cmd and --prep-cmd expands to the --build-dir operand converted to an absolute path. Use --no-clean to preserve @BUILDDIR@ on exit.
- -w, --gcc-warning-level GCC_WARNING_LEVEL
Adjust GCC warning level. -w0 means no additional warnings, -w1 appends -Wall and -Wextra, and -w2 enables some other useful warnings (default: 2)
- --gcc-add-flag GCC_ADD_FLAG
append the given compiler flag when invoking gcc (can be used multiple times)
- --gcc-add-c-only-flag GCC_ADD_C_ONLY_FLAG
append the given compiler flag when invoking gcc for C (can be used multiple times)
- --gcc-add-cxx-only-flag GCC_ADD_CXX_ONLY_FLAG
append the given compiler flag when invoking gcc for C++ (can be used multiple times)
- --gcc-del-flag GCC_DEL_FLAG
drop the given compiler flag when invoking gcc (can be used multiple times)
- --clang-add-flag CLANG_ADD_FLAG
append the given flag when invoking clang static analyzer (can be used multiple times)
- -U, --embed-context EMBED_CONTEXT
embed a number of lines of context from the source file for the key event (default: 3)
- --version
print the version of csbuild and exit