Fix issues found by md-nits

Fixes #15460 Reviewed-by: Shane Lontis <shane.lontis@oracle.com> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/15461)
2021-05-25 10:28:49 -04:00 · 2021-05-25 10:28:49 -04:00 · 3e3ad3c548
parent 32075a1724
commit 3e3ad3c548
6 changed files with 17 additions and 43 deletions
--- a/CHANGES.md
+++ b/CHANGES.md
@ -12257,7 +12257,7 @@ s-cbc           3624.96k     5258.21k     5530.91k     5624.30k     5628.26k
   *"Brian Havard" <brianh@kheldar.apana.org.au> and Richard Levitte*

 * Rewrite commands to use `NCONF` routines instead of the old `CONF`.
-   New functions to support `NCONF `routines in extension code.
+   New functions to support `NCONF` routines in extension code.
   New function `CONF_set_nconf()`
   to allow functions which take an `NCONF` to also handle the old `LHASH`
   structure: this means that the old `CONF` compatible routines can be
@ -18578,13 +18578,11 @@ ndif
   *Ralf S. Engelschall*

 * Removed dummy files from the 0.9.1b source tree:
-   ```
   crypto/asn1/x crypto/bio/cd crypto/bio/fg crypto/bio/grep crypto/bio/vi
   crypto/bn/asm/......add.c crypto/bn/asm/a.out crypto/dsa/f crypto/md5/f
   crypto/pem/gmon.out crypto/perlasm/f crypto/pkcs7/build crypto/rsa/f
   crypto/sha/asm/f crypto/threads/f ms/zzz ssl/f ssl/f.mak test/f
   util/f.mak util/pl/f util/pl/f.mak crypto/bf/bf_locl.old apps/f
-   ```

   *Ralf S. Engelschall*

--- a/NOTES-PERL.md
+++ b/NOTES-PERL.md
@ -8,7 +8,6 @@ Notes on Perl
 - [Required Perl modules](#required-perl-modules)
 - [Notes on installing a Perl module](#notes-on-installing-a-perl-module])

-
 General Notes
 -------------

@ -70,35 +69,18 @@ Required Perl modules
 We do our best to limit ourselves to core Perl modules to keep the
 requirements down. There are just a few exceptions.

+ * Text::Template this is required *for building*

-## For Building
+   To avoid unnecessary initial hurdles, we include a copy of this module
+   in the source. It will work as a fallback if the module isn't already
+   installed.

- * `Text::Template`
+ * `Test::More` this is required *for testing*

-   This module is not part of the core Perl modules.
-   As a matter of fact, the core Perl modules do not
-   include any templating module to date.
-   This module is absolutely needed,
-   configuration depends on it.
-
-## For Testing
-
- * `Test::More`
-
-   We require the minimum version to be 0.96, which
-   appeared in Perl 5.13.4, because that version was
-   the first to have all the features we're using.
-   This module is required for testing only!
-   If you don't plan on running the tests,
-   you don't need to bother with this one.
-
-
-
-To avoid unnecessary initial hurdles, we have bundled a copy of the
-following modules in our source.  They will work as fallbacks if
-these modules aren't already installed on the system.
-
-   Text::Template
+   We require the minimum version to be 0.96, which appeared in Perl 5.13.4,
+   because that version was the first to have all the features we're using.
+   This module is required for testing only!  If you don't plan on running
+   the tests, you don't need to bother with this one.

 Notes on installing a Perl module
 ---------------------------------
--- a/NOTES-VMS.md
+++ b/NOTES-VMS.md
@ -8,7 +8,6 @@ Notes for the OpenVMS platform
 - [About debugging](#about-debugging)
 - [Checking the distribution](#checking-the-distribution)

-
 Requirement details
 -------------------

--- a/NOTES-WINDOWS.md
+++ b/NOTES-WINDOWS.md
@ -8,7 +8,6 @@ Notes for Windows platforms
 - [Linking native applications](#linking-native-applications)
 - [Hosted builds using Cygwin](#hosted-builds-using-cygwin)

-
 There are various options to build and run OpenSSL on the Windows platforms.

 "Native" OpenSSL uses the Windows APIs directly at run time.
--- a/README-PROVIDERS.md
+++ b/README-PROVIDERS.md
@ -9,7 +9,6 @@ Providers
    - [The Null Provider](#the-null-provider)
 - [Loading Providers](#loading-providers)

-
 Standard Providers
 ==================

@ -23,7 +22,6 @@ manual page.

 [provider(7)]: https://www.openssl.org/docs/manmaster/man7/provider.html

-
 The Default Provider
 --------------------

@ -83,11 +81,9 @@ automatically loaded, the null provider can be loaded instead.
 This can be useful if you are using non-default library contexts and want
 to ensure that the default library context is never used unintentionally.

-
 Loading Providers
 =================

-
 Providers to be loaded can be specified in the OpenSSL config file.
 See the [config(5)] manual page for information about how to configure
 providers via the config file, and how to automatically activate them.
@ -112,14 +108,12 @@ the legacy and the default provider in the default library context.
    [legacy_sect]
    activate = 1

-
 It is also possible to load providers programmatically. For example you can
 load the legacy provider into the default library context as shown below.
 Note that once you have explicitly loaded a provider into the library context
 the default provider will no longer be automatically loaded. Therefore you will
 often also want to explicitly load the default provider, as is done here:

-
    #include <stdio.h>
    #include <stdlib.h>

--- a/doc/life-cycles/README.md
+++ b/doc/life-cycles/README.md
@ -1,3 +1,6 @@
+Algorithm Life-Cycle Diagrams
+=============================
+
 This directory contains the algorithm life-cycle diagram sources.

 The canonical life-cycles are in the spreadsheet.
@ -6,11 +9,10 @@ The various .dot files are graph descriptions for the
 [GraphViz](https://www.graphviz.org/) tool.  These omit edges and should
 be used for guidance only.

-To generate the rendered images, you need to install:
-``` sh
-sudo apt install graphviz cpanminus
-sudo cpanm Graph::Easy
-```
+To generate the rendered images, you need to install the following packages:
+
+    sudo apt install graphviz cpanminus
+    sudo cpanm Graph::Easy

 Running `make` will produce a number of `.txt` and `.png` files.
 These are the rendered `.dot` files.  The `.txt` files require