1CSBUILD(1)                       User Commands                      CSBUILD(1)
2
3
4

NAME

6       csbuild - tool for plugging static analyzers into the build process
7

DESCRIPTION

9       usage: csbuild [-h] -c BUILD_CMD [-g GIT_COMMIT_RANGE] [--git-bisect]
10
11              [--added-exit-code    ADDED_EXIT_CODE]    [--base-fail-exit-code
12              BASE_FAIL_EXIT_CODE]   [--print-current]    [--no-print-current]
13              [--print-added]        [--no-print-added]        [--print-fixed]
14              [--no-print-fixed]  [--clean]   [--no-clean]   [--cswrap-timeout
15              CSWRAP_TIMEOUT]    [--color]   [--no-color]   [--gen-travis-yml]
16              [--install   INSTALL]   [--prep-cmd    PREP_CMD]    [--build-dir
17              BUILD_DIR]  [-w GCC_WARNING_LEVEL] [--gcc-add-flag GCC_ADD_FLAG]
18              [--gcc-add-c-only-flag                      GCC_ADD_C_ONLY_FLAG]
19              [--gcc-add-cxx-only-flag  GCC_ADD_CXX_ONLY_FLAG] [--gcc-del-flag
20              GCC_DEL_FLAG] [--clang-add-flag CLANG_ADD_FLAG]  [-U  EMBED_CON‐
21              TEXT] [--version]
22
23   optional arguments:
24       -h, --help
25              show this help message and exit
26
27       -c BUILD_CMD, --build-cmd BUILD_CMD
28              Shell  command  used to build the sources. It runs in @BUILDDIR@
29              (which defaults  to  $PWD  if  --build-dir  is  not  specified).
30              @SRCDIR@ expands to $PWD at the time of csbuild's invocation.
31
32       -g GIT_COMMIT_RANGE, --git-commit-range GIT_COMMIT_RANGE
33              range  of  git  revisions  for  a  differential  scan  in format
34              OLD_REV..NEW_REV
35
36       --git-bisect
37              if a new defect is added, use git-bisect to identify  the  cause
38              WARNING: The given command must (re)compile all sources for this
39              option to work!
40
41       --added-exit-code ADDED_EXIT_CODE
42              exit code to return if there is any defect added in the new ver‐
43              sion (default: 7)
44
45       --base-fail-exit-code BASE_FAIL_EXIT_CODE
46              exit code to return if the base scan fails (default: 0)
47
48       --print-current
49              print  all  defects in the current version (default unless -g is
50              given) WARNING: The given command must (re)compile  all  sources
51              for this option to work!
52
53       --no-print-current
54              disables --print-current
55
56       --print-added
57              print defects added in the new version (default if -g is given)
58
59       --no-print-added
60              disables --print-added
61
62       --print-fixed
63              print  defects  fixed in the new version WARNING: The given com‐
64              mand must (re)compile all sources for this option to work!
65
66       --no-print-fixed
67              disables --print-fixed
68
69       --clean
70              clean the temporary directory with results (and  @BUILDDIR@)  on
71              exit (default)
72
73       --no-clean
74              disables --clean
75
76       --cswrap-timeout CSWRAP_TIMEOUT
77              maximal  amount of time in seconds taken by analysis of a single
78              module (default: 30)
79
80       --color
81              use colorized console output (default if connected to a tty)
82
83       --no-color
84              disables --color
85
86       --gen-travis-yml
87              generate the .travis.yml file for Travis CI (requires --install)
88
89       --install INSTALL
90              space-separated   list   of    packages    to    install    with
91              --gen-travis-yml
92
93       --prep-cmd PREP_CMD
94              Shell  command  to  run  before the build. It runs in @BUILDDIR@
95              (which defaults  to  $PWD  if  --build-dir  is  not  specified).
96              @SRCDIR@ expands to $PWD at the time of csbuild's invocation.
97
98       --build-dir BUILD_DIR
99              Directory  to  be  created to run the prep and build commands in
100              (optional). If not specified, the commands run in $PWD.  @BUILD‐
101              DIR@ in the operand of --build-cmd and --prep-cmd expands to the
102              --build-dir  operand  converted  to  an   absolute   path.   Use
103              --no-clean to preserve @BUILDDIR@ on exit.
104
105       -w GCC_WARNING_LEVEL, --gcc-warning-level GCC_WARNING_LEVEL
106              Adjust  GCC warning level. -w0 means no additional warnings, -w1
107              appends -Wall and -Wextra, and -w2  enables  some  other  useful
108              warnings (default: 2)
109
110       --gcc-add-flag GCC_ADD_FLAG
111              append  the  given  compiler flag when invoking gcc (can be used
112              multiple times)
113
114       --gcc-add-c-only-flag GCC_ADD_C_ONLY_FLAG
115              append the given compiler flag when invoking gcc for C  (can  be
116              used multiple times)
117
118       --gcc-add-cxx-only-flag GCC_ADD_CXX_ONLY_FLAG
119              append the given compiler flag when invoking gcc for C++ (can be
120              used multiple times)
121
122       --gcc-del-flag GCC_DEL_FLAG
123              drop the given compiler flag when invoking gcc (can be used mul‐
124              tiple times)
125
126       --clang-add-flag CLANG_ADD_FLAG
127              append  the  given flag when invoking clang static analyzer (can
128              be used multiple times)
129
130       -U EMBED_CONTEXT, --embed-context EMBED_CONTEXT
131              embed a number of lines of context from the source file for  the
132              key event (default: 3)
133
134       --version
135              print the version of csbuild and exit
136
137
138
139csbuild csmock-2.7.1-1.fc33      February 2021                      CSBUILD(1)