INSTALL.md: Restore $ as command prompt indicator
[openssl.git] / INSTALL.md
index 981a86af047ed813562b2e1ffdfad3ae431b9ec2..445c28b127956cb441c3e20b1e86cfc863de8b2b 100644 (file)
@@ -663,7 +663,7 @@ external test suites are currently supported:
  - Python PYCA/Cryptography test suite
  - krb5 test suite
 
-See the file [test/README.external]/(test/README.external) for further details.
+See the file [test/README.external](test/README.external) for further details.
 
 ### no-filenames
 
@@ -1026,7 +1026,7 @@ configuration.  The following variables are supported:
 These cannot be mixed with compiling/linking flags given on the command line.
 In other words, something like this isn't permitted.
 
-    ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
+    ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
 
 Backward compatibility note:
 
@@ -1038,11 +1038,11 @@ for the following:
 
 For example, the following command will not see -DBAR:
 
-    CPPFLAGS=-DBAR ./config -DCOOKIE
+    CPPFLAGS=-DBAR ./config -DCOOKIE
 
 However, the following will see both set variables:
 
-    CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- ./config -DCOOKIE
+    CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- ./config -DCOOKIE
 
 If CC is set, it is advisable to also set CXX to ensure both the C and C++
 compiler are in the same "family".  This becomes relevant with
@@ -1344,7 +1344,7 @@ With the default OpenSSL installation comes a FIPS provider module, which
 needs some post-installation attention, without which it will not be usable.
 This involves using the following command:
 
-    openssl fipsinstall
+    openssl fipsinstall
 
 See the openssl-fipsinstall(1) manual for details and examples.
 
@@ -1618,7 +1618,7 @@ Note: To make the output readable, pleace add a 'code fence' (three backquotes
 ` ``` ` on a separate line) before and after your output:
 
      ```
-     ./Configure [your arguments...]
+     ./Configure [your arguments...]
 
      [output...]
 
@@ -1658,21 +1658,28 @@ Test Failures
 -------------
 
 If some tests fail, look at the output.  There may be reasons for the failure
-that isn't a problem in OpenSSL itself (like a malfunction with Perl).
+that isn't a problem in OpenSSL itself (like an OS malfunction or a Perl issue).
 You may want increased verbosity, that can be accomplished like this:
 
-Verbosity on failure only (make macro VERBOSE_FAILURE or VF):
-
-    $ make VF=1 test                                 # Unix
-    $ mms /macro=(VF=1) test                         ! OpenVMS
-    $ nmake VF=1 test                                # Windows
-
-Full verbosity (make macro VERBOSE or V):
+Full verbosity (`make` macro `VERBOSE` or `V`):
 
     $ make V=1 test                                  # Unix
     $ mms /macro=(V=1) test                          ! OpenVMS
     $ nmake V=1 test                                 # Windows
 
+Verbosity on test failure (`VERBOSE_FAILURE` or `VF´, Unix example shown):
+
+    $ make test VF=1
+
+Verbosity on failed (sub-)tests only (`VERBOSE_FAILURES_ONLY` or `VFO`):
+
+    $ make test VFO=1
+
+Verbosity on failed (sub-)tests, in addition progress on succeeded (sub-)tests
+(`VERBOSE_FAILURES_PROGRESS` or `VFP`):
+
+    $ make test VFP=1
+
 If you want to run just one or a few specific tests, you can use
 the make variable TESTS to specify them, like this:
 
@@ -1680,9 +1687,10 @@ the make variable TESTS to specify them, like this:
     $ mms/macro="TESTS=test_rsa test_dsa" test       ! OpenVMS
     $ nmake TESTS='test_rsa test_dsa' test           # Windows
 
-And of course, you can combine (Unix example shown):
+And of course, you can combine (Unix examples shown):
 
-    $ make VF=1 TESTS='test_rsa test_dsa' test
+    $ make test TESTS='test_rsa test_dsa' VF=1
+    $ make test TESTS="test_cmp_*" VFO=1
 
 You can find the list of available tests like this: