Skip to content

Commit

Permalink
Merge pull request #55 from dkrupp/master
Browse files Browse the repository at this point in the history
fix skip file doc
  • Loading branch information
dkrupp committed Aug 26, 2015
2 parents 04b69ab + c2dd4cd commit 72075b4
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,14 +150,16 @@ advised to always provide (the same) suppress file for the checks.
~~~~~~~~~~~~~~~~~~~~~
-s SKIPFILE, --skip SKIPFILE
~~~~~~~~~~~~~~~~~~~~~

Paths and source files which will not be checked.
This is useful to skip the checking of used source code libraries or system headers.
With a skip file you can filter which files should or shouldn't be checked.
Each line in a skip file should start with a '-' or '+' character followed by a path glob pattern. A minus character means that if a checked file path - including the headers - matches with the pattern, the file will not be checked. The plus character means the opposite: if a file path matches with the pattern, it will be checked.
CodeChecker reads the file from top to bottom and stops at the first matching pattern.

For example:
~~~~~~~~~~~~~~~~~~~~~
/skip/all/source/in/path
/do/not/check/this.file
-/skip/all/source/in/directory*
-/do/not/check/this.file
+/dir/check.this.file
-/dir/*
~~~~~~~~~~~~~~~~~~~~~

###Enable/Disable checkers
Expand Down

0 comments on commit 72075b4

Please sign in to comment.