Skip to content

Commit 2c8684e

Browse files
author
gberkes
committed
Document importance of reviewing cppcheck_suppressions.txt during development and usage of assertions.
1 parent 0aa711a commit 2c8684e

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,12 @@ $ cd test
213213
$ ./regression-tests
214214
$ ./unit-tests
215215
```
216+
Please take care that the '<path/to/modsecurity>/test/cppcheck_suppressions.txt'
217+
file contains hardcoded 'filename:line number' suppressions. If you modify a
218+
file with explicit suppressions, you must update the 'cppcheck_suppressions.txt'
219+
accordingly to ensure the suppression references remain aligned with the
220+
intended lines of code. Failing to do so might trigger 'make check-static' to
221+
break the build with errors that are logically unrelated to your modifications.
216222

217223
### Debugging
218224

@@ -235,7 +241,12 @@ $ ./configure --enable-assertions=yes
235241
$ make
236242
$ sudo make install
237243
```
244+
"Assertions allow us to document assumptions and to spot violations early in the
245+
development process. What is more, assertions allow us to spot violations with a
246+
minimum of effort." https://dl.acm.org/doi/pdf/10.1145/240964.240969
238247

248+
It is recommended to use assertions where applicable, and to enable them with
249+
'--enable-assertions=yes' during the testing and debugging workflow.
239250

240251
## Reporting Issues
241252

0 commit comments

Comments
 (0)