Skip to content

Commit 053e3b5

Browse files
author
gberkes
committed
Document the usage and the importance of assertions.
1 parent b465995 commit 053e3b5

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,10 +236,16 @@ CFLAGS to disable the compilation optimization parameters:
236236
```shell
237237
$ export CFLAGS="-g -O0"
238238
$ ./build.sh
239-
$ ./configure
239+
$ ./configure --enable-assertions=yes
240240
$ make
241241
$ sudo make install
242242
```
243+
"Assertions allow us to document assumptions and to spot violations early in the
244+
development process. What is more, assertions allow us to spot violations with a
245+
minimum of effort." https://dl.acm.org/doi/pdf/10.1145/240964.240969
246+
247+
It is recommended to use assertions where applicable, and to enable them with
248+
'--enable-assertions=yes' during the testing and debugging workflow.
243249

244250
### Benchmarking
245251

0 commit comments

Comments
 (0)