Unify the markdown links to the NOTES and README files

In many locations, the files have been converted to markdown
syntactically, but don't utilize the power of markdown yet.
Here, instead of just repeating the file name, the markdown link
now shows the title of the document.

Additionally, the notes are now reference in the same order in both
the README and the INSTALL file.

Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14042)

diff --git a/INSTALL.md b/INSTALL.md
index 0d9665999a9d6e1c3a0e42dd1291ebb70b15c19c..01c360e8d4013198bda8253fd47b6eefd5cc59af 100644 (file)
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -58,13 +58,13 @@ To install OpenSSL, you will need:
 For additional platform specific requirements, solutions to specific
 issues and other details, please read one of these:
 
- * [NOTES-UNIX.md](NOTES-UNIX.md) - notes for Unix like systems
- * [NOTES-VMS.md](NOTES-VMS.md) - notes related to OpenVMS
- * [NOTES-WINDOWS.md](NOTES-WINDOWS.md) - notes related to the Windows platform
- * [NOTES-DJGPP.md](NOTES-DJGPP.md) - building for DOS with DJGPP
- * [NOTES-ANDROID.md](NOTES-ANDROID.md) - building for Android platforms (using NDK)
- * [NOTES-VALGRIND.md](NOTES-VALGRIND.md) - testing with Valgrind
- * [NOTES-PERL.m](NOTES-PERL.md) - some notes on Perl
+ * [Notes for UNIX-like platforms](NOTES-UNIX.md)
+ * [Notes for Android platforms](NOTES-ANDROID.md)
+ * [Notes for Windows platforms](NOTES-WINDOWS.md)
+ * [Notes for the DOS platform with DJGPP](NOTES-DJGPP.md)
+ * [Notes for the OpenVMS platform](NOTES-VMS.md)
+ * [Notes on Perl](NOTES-PERL.md)
+ * [Notes on Valgrind](NOTES-VALGRIND.md)
 
 Notational conventions
 ======================

diff --git a/NOTES-ANDROID.md b/NOTES-ANDROID.md
index e1e7370d2646f2054e7f572604693c73e6bdeb0b..eebf03a4c496a0692be1169c09c955ee824e7654 100644 (file)
--- a/NOTES-ANDROID.md
+++ b/NOTES-ANDROID.md
@@ -1,4 +1,4 @@
-NOTES FOR ANDROID PLATFORMS
+Notes for Android platforms
 ===========================
 
  Requirement details

diff --git a/NOTES-DJGPP.md b/NOTES-DJGPP.md
index 157b11b4781fac6e7f5ba6ac6b8534e097b9b574..0b23c48370b330563fbce262c57a07d79a8df5cc 100644 (file)
--- a/NOTES-DJGPP.md
+++ b/NOTES-DJGPP.md
@@ -1,5 +1,5 @@
-INSTALLATION ON THE DOS PLATFORM WITH DJGPP
-===========================================
+Notes for the DOS platform with DJGPP
+=====================================
 
  OpenSSL has been ported to DJGPP, a Unix look-alike 32-bit run-time
  environment for 16-bit DOS, but only with long filename support.

diff --git a/NOTES-UNIX.md b/NOTES-UNIX.md
index 0928753149cea0f3dfb2b4c8f973f2470b7d4015..0b0a531db4a1cf681969a63a61761205def00206 100644 (file)
--- a/NOTES-UNIX.md
+++ b/NOTES-UNIX.md
@@ -1,8 +1,8 @@
-NOTES FOR UNIX-LIKE PLATFORMS
+Notes for UNIX-like platforms
 =============================
 
  For Unix/POSIX runtime systems on Windows,
- please see [NOTES-WINDOWS.md](NOTES-WINDOWS.md).
+ please see the [Notes for Windows platforms](NOTES-WINDOWS.md).
 
  OpenSSL uses the compiler to link programs and shared libraries
  ---------------------------------------------------------------

diff --git a/NOTES-VALGRIND.md b/NOTES-VALGRIND.md
index 00647cbd9b726dd7f23f9c614c7e4fb2f36ec97b..a37e323e23fbe16f2ce0e3164920a76f16c4b2e2 100644 (file)
--- a/NOTES-VALGRIND.md
+++ b/NOTES-VALGRIND.md
@@ -1,5 +1,5 @@
-NOTES FOR VALGRIND
-==================
+Notes on Valgrind
+=================
 
 Valgrind is a test harness that includes many tools such as memcheck,
 which is commonly used to check for memory leaks, etc. The default tool

diff --git a/README.md b/README.md
index 9f64bad686542b6ef0b52b7f7fd9ffa7c33eb1a7..680faea76f1cca9a948fd85ee927a4e1be3cd159 100644 (file)
--- a/README.md
+++ b/README.md
@@ -105,13 +105,13 @@ detailed instructions about building and installing OpenSSL. For some
 platforms, the installation instructions are amended by a platform specific
 document.
 
- * [NOTES-ANDROID.md](NOTES-ANDROID.md)
- * [NOTES-DJGPP.md](NOTES-DJGPP.md)
- * [NOTES-UNIX.md](NOTES-UNIX.md)
- * [NOTES-VMS.md](NOTES-VMS.md)
- * [NOTES-WINDOWS.md](NOTES-WINDOWS.md)
- * [NOTES-PERL.md](NOTES-PERL.md)
- * [NOTES-VALGRIND.md](NOTES-VALGRIND.md)
+ * [Notes for UNIX-like platforms](NOTES-UNIX.md)
+ * [Notes for Android platforms](NOTES-ANDROID.md)
+ * [Notes for Windows platforms](NOTES-WINDOWS.md)
+ * [Notes for the DOS platform with DJGPP](NOTES-DJGPP.md)
+ * [Notes for the OpenVMS platform](NOTES-VMS.md)
+ * [Notes on Perl](NOTES-PERL.md)
+ * [Notes on Valgrind](NOTES-VALGRIND.md)
 
 Specific notes on upgrading to OpenSSL 3.0 from previous versions, as well as
 known issues are available on the [OpenSSL 3.0 Wiki] page.