Skip to content

Commit c630be7

Browse files
committed
Manual; minor tweaks of lists
1 parent ba00046 commit c630be7

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

man/manual.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ The checks in Cppcheck are not perfect. There are bugs that should be found, tha
2525

2626
The kinds of bugs that you can find with static analysis are:
2727

28-
- undefined behavior
29-
- using dangerous code patterns
30-
- coding style
28+
- Undefined behavior
29+
- Using dangerous code patterns
30+
- Coding style
3131

3232
There are many bugs that you can not find with static analysis. Static analysis tools do not have human knowledge about
3333
what your program is intended to do. If the output from your program is valid but unexpected then in most cases this is
@@ -36,10 +36,10 @@ it is unlikely that any tool will complain about that.
3636

3737
Static analysis should be used as a complement in your quality assurance. It does not replace any of;
3838

39-
- careful design
40-
- testing
41-
- dynamic analysis
42-
- fuzzing
39+
- Careful design
40+
- Testing
41+
- Dynamic analysis
42+
- Fuzzing
4343

4444
# Getting started
4545

@@ -237,10 +237,17 @@ Using a Cppcheck build folder is not mandatory but it is recommended.
237237
Cppcheck save analyzer information in that folder.
238238

239239
The advantages are;
240-
* It speeds up the analysis as it makes incremental analysis possible. Only changed files are analyzed when you recheck.
241-
* Whole program analysis also when multiple threads are used.
242240

243-
On the command line you configure that through `--cppcheck-build-dir=path`. In the GUI it is configured in the project settings.
241+
- It speeds up the analysis as it makes incremental analysis possible. Only changed files are analyzed when you recheck.
242+
- Whole program analysis also when multiple threads are used.
243+
244+
On the command line you configure that through `--cppcheck-build-dir=path`. Example:
245+
246+
mkdir b
247+
cppcheck --cppcheck-build-dir=b src # <- All files are analyzed
248+
cppcheck --cppcheck-build-dir=b src # <- Faster! Results of unchanged files are reused
249+
250+
In the GUI it is configured in the project settings.
244251

245252
# Importing a project
246253

0 commit comments

Comments
 (0)