Improve comments on constant-flow testing in config.h

Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
This commit is contained in:
Manuel Pégourié-Gonnard 2020-08-24 12:58:36 +02:00
parent 8a79b9b68c
commit dd00bfce34

View file

@ -1913,9 +1913,10 @@
* *
* Enable testing of the constant-flow nature of some sensitive functions with * Enable testing of the constant-flow nature of some sensitive functions with
* clang's MemorySanitizer. This causes some existing tests to also test * clang's MemorySanitizer. This causes some existing tests to also test
* non-functional properties of the code under test. * this non-functional property of the code under test.
* *
* This setting requires compiling with clang -fsanitize=memory. * This setting requires compiling with clang -fsanitize=memory. The test
* suites can then be run normally.
* *
* \warning This macro is only used for extended testing; it is not considered * \warning This macro is only used for extended testing; it is not considered
* part of the library's API, so it may change or disappear at any time. * part of the library's API, so it may change or disappear at any time.
@ -1929,10 +1930,12 @@
* *
* Enable testing of the constant-flow nature of some sensitive functions with * Enable testing of the constant-flow nature of some sensitive functions with
* valgrind's memcheck tool. This causes some existing tests to also test * valgrind's memcheck tool. This causes some existing tests to also test
* non-functional properties of the code under test. * this non-functional property of the code under test.
* *
* This setting requires valgrind headers for building, and is only useful for * This setting requires valgrind headers for building, and is only useful for
* testing if the tests suites are run with valgrind's memcheck. * testing if the tests suites are run with valgrind's memcheck. This can be
* done for an individual test suite with 'valgrind ./test_suite_xxx', or when
* using CMake, this can be done for all test suites with 'make memcheck'.
* *
* \warning This macro is only used for extended testing; it is not considered * \warning This macro is only used for extended testing; it is not considered
* part of the library's API, so it may change or disappear at any time. * part of the library's API, so it may change or disappear at any time.