diff options
| author | Dwiczz <cody.danielewicz@gmail.com> | 2024-04-16 13:12:51 -0400 |
|---|---|---|
| committer | Tomas Mraz <tomas@openssl.org> | 2024-04-18 11:02:29 +0200 |
| commit | 35950cea02292ad63b24a928e40ec1d35542bcd1 (patch) | |
| tree | 03466e37aff805fadc8bae594fea8704b0fd934f | |
| parent | e1fd043ad7fa865a8ef9160c892b49a098d23c71 (diff) | |
Updated list formatting, added hyperlinks, modernized syntax
Updated list formatting to allow for easier readability, Added/adjusted hyperlinks, modernized command substitution syntax
CLA: trivial
Reviewed-by: Paul Dale <ppzgs1@gmail.com>
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
(Merged from https://github.com/openssl/openssl/pull/24165)
| -rw-r--r-- | NOTES-VALGRIND.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/NOTES-VALGRIND.md b/NOTES-VALGRIND.md index 2700324efa..96f0df1d19 100644 --- a/NOTES-VALGRIND.md +++ b/NOTES-VALGRIND.md @@ -1,9 +1,9 @@ Notes on Valgrind ================= -Valgrind is a test harness that includes many tools such as memcheck, +[Valgrind](https://valgrind.org/) is a test harness that includes many tools such as memcheck, which is commonly used to check for memory leaks, etc. The default tool -run by Valgrind is memcheck. There are other tools available, but this +run by Valgrind is memcheck. There are [other tools available](https://valgrind.org/info/tools.html), but this will focus on memcheck. Valgrind runs programs in a virtual machine, this means OpenSSL unit @@ -13,11 +13,11 @@ Requirements ------------ 1. Platform supported by Valgrind - See <http://valgrind.org/info/platforms.html> + - See [Valgrind Supported Platforms](http://valgrind.org/info/platforms.html) 2. Valgrind installed on the platform - See <http://valgrind.org/downloads/current.html> + - See [Valgrind Current Releases](http://valgrind.org/downloads/current.html) 3. OpenSSL compiled - See [INSTALL.md](INSTALL.md) + - See [INSTALL.md](INSTALL.md) Running Tests ------------- @@ -32,7 +32,7 @@ to allow programs to find shared libraries. The variable can be modified to specify a different executable environment. EXE_SHELL=\ - "`/bin/pwd`/util/wrap.pl valgrind --error-exitcode=1 --leak-check=full -q" + "$(/bin/pwd)/util/wrap.pl valgrind --error-exitcode=1 --leak-check=full -q" This will start up Valgrind with the default checker (`memcheck`). The `--error-exitcode=1` option specifies that Valgrind should exit with an @@ -62,11 +62,11 @@ file [test/README.md](test/README.md). Example command line: - $ make test EXE_SHELL="`/bin/pwd`/util/wrap.pl valgrind --error-exitcode=1 \ + $ make test EXE_SHELL="$(/bin/pwd)/util/wrap.pl valgrind --error-exitcode=1 \ --leak-check=full -q" OPENSSL_ia32cap=":0" If an error occurs, you can then run the specific test via the `TESTS` variable with the `VERBOSE` or `VF` or `VFP` options to gather additional information. - $ make test VERBOSE=1 TESTS=test_test EXE_SHELL="`/bin/pwd`/util/wrap.pl \ + $ make test VERBOSE=1 TESTS=test_test EXE_SHELL="$(/bin/pwd)/util/wrap.pl \ valgrind --error-exitcode=1 --leak-check=full -q" OPENSSL_ia32cap=":0" |