Blame view

RIOT/dist/tools/cppcheck/README.md 1.34 KB
a752c7ab   elopes   add first test an...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
  # About
  
  This is a cppcheck wrapper script with appropriate parameters for
  checking RIOT.
  It accepts a branch name as an argument which is used to limit the
  scope of the check. Other parameters will be passed to cppcheck, so
  you can further modify its behavior.
  
  # Example usage
  
  Check all files changed in the current branch against the branch named
  'master':
  
      ./dist/tools/cppcheck/check.sh master
  
  Check all files but ignore warnings about unused struct members:
  
      ./dist/tools/cppcheck/check.sh --suppress=unassignedVariable
  
  Check all files changed in the current branch against the branch named
  'master', ignoring warnings about unassigned variables:
  
      ./dist/tools/cppcheck/check.sh master  --suppress=unassignedVariable
  
  # Default options
  
  This script suppresses warnings of the type "unusedStructMember" by default. If
  you want to get warnings about "unusedStructMembers" run the script with the
  --show-unused-struct option:
      ./dist/tools/cppcheck/check.sh  --show-unused-struct [BRANCH] [options to be passed]
  
  # What to do about the findings
  
  You should read the code carefully. While cppcheck certainly produces
  valuable information, it can also warn about code that is actually OK.
  If this happens, you can add an "inline suppression" like this:
  
      /* cppcheck-suppress passedByValue */
      timex_t timex_add(const timex_t a, const timex_t b);