Skip to content

manual: add description about namingng. if misra is needed then cppcheck premium is recommended. do not describe misra.py in premium manual because that shouldn't be used. #7518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danmar merged 2 commits into from
May 9, 2025
+100 −40
Merged

manual: add description about namingng. if misra is needed then cppcheck premium is recommended. do not describe misra.py in premium manual because that shouldn't be used. #7518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
49ad998
manual: add description about namingng. if misra is needed then cppch…
danmar May 9, 2025
bed05de
fix
danmar May 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 42 additions & 21 deletions man/manual-premium.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -981,47 +981,68 @@ Cppcheck is distributed with a few addons which are listed below.

## Supported addons

### misra.py
### namingng.py

[namingng.py](https://github.com/danmar/cppcheck/blob/main/addons/namingng.py) allows you to configure and check naming conventions.

You need to have a configuration file that defines your naming conventions. By default the filename `namingng.config.json` is used but there is an option so you can use any filename you want.

Example configuration of naming conventions:
```
{
"RE_VARNAME": ["[a-z]*[a-zA-Z0-9_]*\\Z"],
"RE_PRIVATE_MEMBER_VARIABLE": null,
"RE_FUNCTIONNAME": ["[a-z0-9A-Z]*\\Z"],
"_comment": "comments can be added to the config with underscore-prefixed keys",
"include_guard": {
"input": "path",
"prefix": "GUARD_",
"case": "upper",
"max_linenr": 5,
"RE_HEADERFILE": "[^/].*\\.h\\Z",
"required": true
},
"var_prefixes": {"uint32_t": "ui32"},
"function_prefixes": {"uint16_t": "ui16",
"uint32_t": "ui32"}
}
```

[misra.py](https://github.com/danmar/cppcheck/blob/main/addons/misra.py) is used to verify compliance with MISRA C 2012, a proprietary set of guidelines to avoid questionable code, developed for embedded systems.
### threadsafety.py

The full list of supported rules is available on: [https://files.cppchecksolutions.com/misrac2023.html](https://files.cppchecksolutions.com/misrac2023.html)
[threadsafety.py](https://github.com/danmar/cppcheck/blob/main/addons/threadsafety.py) analyses Cppcheck dump files to locate thread safety issues like static local objects used by multiple threads.

### y2038.py

[y2038.py](https://github.com/danmar/cppcheck/blob/main/addons/y2038.py) checks Linux systems for [year 2038 problem](https://en.wikipedia.org/wiki/Year_2038_problem) safety. This required [modified environment](https://github.com/3adev/y2038). See complete description [here](https://github.com/danmar/cppcheck/blob/main/addons/doc/y2038.txt).

### threadsafety.py

[threadsafety.py](https://github.com/danmar/cppcheck/blob/main/addons/threadsafety.py) analyses Cppcheck dump files to locate thread safety issues like static local objects used by multiple threads.

## Running Addons

Addons could be run through Cppcheck command line utility as follows:
Addons can be executed with the `--addon` option:

cppcheck --addon=misra.py somefile.c
cppcheck --addon=namingng.py somefile.c

This will launch all Cppcheck checks and additionally calls specific checks provided by selected addon.
Likewise, if you have created your own script you can execute that:

Some addons need extra arguments. You can configure how you want to execute an addon in a json file. For example put this in misra.json:
cppcheck --addon=mychecks.py somefile.c

You can configure how you want to execute an addon in a json file. For example:

{
"script": "misra.py",
"script": "mychecks.py",
"args": [
"--rule-texts=misra.txt"
]
"--some-option"
],
"ctu": false
}

And then the configuration can be executed on the Cppcheck command line:

cppcheck --addon=misra.json somefile.c
To use that json file to execute your addon use the --addon option:

By default Cppcheck would search addon at the standard path which was specified
during the installation process. You also can set this path directly, for example:
cppcheck --addon=mychecks.json somefile.c

cppcheck --addon=/opt/cppcheck/configurations/my_misra.json somefile.c
Cppcheck search for addons in the local folder first and then in the installation folder. A different path can be specified explicitly, for instance:

This allows you to create and manage multiple configuration files for different projects.
cppcheck --addon=path/to/my-addon.py somefile.c

# Library configuration

Expand Down
77 changes: 58 additions & 19 deletions man/manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -986,47 +986,86 @@ Cppcheck is distributed with a few addons which are listed below.

[misra.py](https://github.com/danmar/cppcheck/blob/main/addons/misra.py) is used to verify compliance with MISRA C 2012, a proprietary set of guidelines to avoid questionable code, developed for embedded systems.

The misra rule texts should be downloaded from [MISRA](https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/tools)
The misra.py script does not provide rule texts, those should be downloaded from [MISRA](https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/tools)

Use the option `--rule-texts` to specify the rules text file that has been downloaded from [MISRA](https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/tools).
To load the rule texts, create a configuration file. Example `misra.json`:

Checkers in open source Cppcheck only cover MISRA rules partially.
{
"script": "misra.py",
"args": [
"--rule-texts=misra_c_2012__headlines_for_cppcheck - AMD1+AMD2.txt"
],
"ctu": true
}

### y2038.py
To use that `misra.json` in Cppcheck analysis, use option `--addon=misra.json`:

[y2038.py](https://github.com/danmar/cppcheck/blob/main/addons/y2038.py) checks Linux systems for [year 2038 problem](https://en.wikipedia.org/wiki/Year_2038_problem) safety. This required [modified environment](https://github.com/3adev/y2038). See complete description [here](https://github.com/danmar/cppcheck/blob/main/addons/doc/y2038.txt).
cppcheck --addon=misra.json --enable=style somefile.c

Misra checkers in open source Cppcheck only cover MISRA rules partially and for full coverage use Cppcheck Premium.

### namingng.py

[namingng.py](https://github.com/danmar/cppcheck/blob/main/addons/namingng.py) allows you to configure and check naming conventions.

You need to have a configuration file that defines your naming conventions. By default the filename `namingng.config.json` is used but there is an option so you can use any filename you want.

Example configuration of naming conventions:
```
{
"RE_VARNAME": ["[a-z]*[a-zA-Z0-9_]*\\Z"],
"RE_PRIVATE_MEMBER_VARIABLE": null,
"RE_FUNCTIONNAME": ["[a-z0-9A-Z]*\\Z"],
"_comment": "comments can be added to the config with underscore-prefixed keys",
"include_guard": {
"input": "path",
"prefix": "GUARD_",
"case": "upper",
"max_linenr": 5,
"RE_HEADERFILE": "[^/].*\\.h\\Z",
"required": true
},
"var_prefixes": {"uint32_t": "ui32"},
"function_prefixes": {"uint16_t": "ui16",
"uint32_t": "ui32"}
}
```

### threadsafety.py

[threadsafety.py](https://github.com/danmar/cppcheck/blob/main/addons/threadsafety.py) analyses Cppcheck dump files to locate thread safety issues like static local objects used by multiple threads.

### y2038.py

[y2038.py](https://github.com/danmar/cppcheck/blob/main/addons/y2038.py) checks Linux systems for [year 2038 problem](https://en.wikipedia.org/wiki/Year_2038_problem) safety. This required [modified environment](https://github.com/3adev/y2038). See complete description [here](https://github.com/danmar/cppcheck/blob/main/addons/doc/y2038.txt).

## Running Addons

Addons could be run through Cppcheck command line utility as follows:
Addons can be executed with the `--addon` option:

cppcheck --addon=namingng.py somefile.c

cppcheck --addon=misra.py somefile.c
Likewise, if you have created your own script you can execute that:

This will launch all Cppcheck checks and additionally calls specific checks provided by selected addon.
cppcheck --addon=mychecks.py somefile.c

Some addons need extra arguments. You can configure how you want to execute an addon in a json file. For example put this in misra.json:
You can configure how you want to execute an addon in a json file. For example:

{
"script": "misra.py",
"script": "mychecks.py",
"args": [
"--rule-texts=misra.txt"
]
"--some-option"
],
"ctu": false
}

And then the configuration can be executed on the Cppcheck command line:

cppcheck --addon=misra.json somefile.c
To use that json file to execute your addon use the --addon option:

By default Cppcheck would search addon at the standard path which was specified
during the installation process. You also can set this path directly, for example:
cppcheck --addon=mychecks.json somefile.c

cppcheck --addon=/opt/cppcheck/configurations/my_misra.json somefile.c
Cppcheck search for addons in the local folder first and then in the installation folder. A different path can be specified explicitly, for instance:

This allows you to create and manage multiple configuration files for different projects.
cppcheck --addon=path/to/my-addon.py somefile.c

# Library configuration

Expand Down
Loading