Document the usage and the importance of assertions.

This commit is contained in:
gberkes 2024-08-04 22:13:58 +02:00
parent b4659959cd
commit 053e3b5266

View File

@ -236,10 +236,16 @@ CFLAGS to disable the compilation optimization parameters:
```shell ```shell
$ export CFLAGS="-g -O0" $ export CFLAGS="-g -O0"
$ ./build.sh $ ./build.sh
$ ./configure $ ./configure --enable-assertions=yes
$ make $ make
$ sudo make install $ sudo make install
``` ```
"Assertions allow us to document assumptions and to spot violations early in the
development process. What is more, assertions allow us to spot violations with a
minimum of effort." https://dl.acm.org/doi/pdf/10.1145/240964.240969
It is recommended to use assertions where applicable, and to enable them with
'--enable-assertions=yes' during the testing and debugging workflow.
### Benchmarking ### Benchmarking