Skip to content

Commit

Permalink
Updated list formatting, added hyperlinks, modernized syntax
Browse files Browse the repository at this point in the history
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 #24165)
  • Loading branch information
Dwiczz authored and t8m committed Apr 18, 2024
1 parent e1fd043 commit 35950ce
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions NOTES-VALGRIND.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
-------------
Expand All @@ -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
Expand Down Expand Up @@ -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"

0 comments on commit 35950ce

Please sign in to comment.