The command-line when using a Compilation Database is:
ccsm [ccsm options] <source0> [... <sourceN>]
If not using a compilation database, use:
ccsm [ccsm options] <source0> [... <sourceN>] -- [compiler options]
A current list of CCSM options can be displayed by running with the --help
option:
ccsm --help
Response files can be used to avoid the need to specify a long list of options
on the command line. When using response files, the command line options are
contained in a text file and that text file is referenced on the command line
using the notation @filename.
For example:
ccsm @opts.txt --
NOTE: Response files cannot be used after the -- separator. If you wish to
avoid having to specify a long list of compiler options, it's necessary to use a
Compilation Database
rather than response files.
Files can be excluded from the results using the -exclude-file option. This
option accepts a comma separated list of regex patterns which will be used to
exclude. For example:
--exclude-file=comment.h$$,free.h$$
would exclude files with names ending comment.h and those ending free.h
--exclude-file=.h$$
would exclude all files with names ending .h (likely most header files)
CCSM includes functionality to check against limits for specific metrics. In
order to use this, a limits file must be specified on the command line using the
--limits option, for example
--limits=limit_file.csv
Please see the limits file format for details of how to specify the file.
Note that the limits checking support does not allow for complex rules to describe the limits. It's suggested that such behaviour be supported by a dedicated custom script which consumes the TSV or CSV output of CCSM.
The format of the output of the limits checking can be customised via the
output-limit-warnings command line option. Supported values are:
| Option | Description |
|---|---|
default |
Free-form descriptive output, e.g. Global failed limits check 'Comments in bytes' (actual: 11 expected: >20): Ensure more than 20 bytes of comments in the project |
gccbrief |
Styles on the "GCC brief" format - filename:line[:column][:severity]:description - e.g. src\limits1.c:2:1:1:no_nest failed limits check 'Number of paths through the function' (actual: 1 expected: <1): Ensure that no_nest has no paths |
byfile |
As with default, but the output is broken into per-file sections |
By default CCSM will output all of the metrics (unless using a sparse output
format, where only metrics with a non-zero value will be output), however the
--output-metrics option allows the caller control over which metrics are
output.
The option takes a set of comma-separated strings, where each string is either:
- The short name of a metric or alias (e.g.
FILE_CNT) or - A regex for one or more metrics or aliases (e.g.
RAW_KW.*). Regular expresions are POSIX format.
For example
--output-metrics=FILE_CNT,RAW_KW.*
The --enable-condition-analysis enables a simple form of condition analysis when
computing path counts. By default, the following code would produce a path count of
2:
if (0) {
...
} else {
...
}as the code, as written, contains two paths. However based on the condition, the first
path can never be followed so the actual number of executable paths is 1. Enabling
condition analysis will result in a simple analysis of the conditions associated with
if and while statements to determine whether such paths are actually executable or
not; in the case that they aren't, they won't be included in the path count.
Please note that the condition analysis is highly rudimentary. It cannot, for example recognise that situations such as:
if (0 == a) {
} else if (0 == a) {
}contain duplicate conditions (which reduce the number of truly executable paths).