Browse Source

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)
master
Dr. Matthias St. Pierre 8 months ago
parent
commit
4148581eb2
6 changed files with 21 additions and 21 deletions
  1. +7
    -7
      INSTALL.md
  2. +1
    -1
      NOTES-ANDROID.md
  3. +2
    -2
      NOTES-DJGPP.md
  4. +2
    -2
      NOTES-UNIX.md
  5. +2
    -2
      NOTES-VALGRIND.md
  6. +7
    -7
      README.md

+ 7
- 7
INSTALL.md View File

@ -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
======================


+ 1
- 1
NOTES-ANDROID.md View File

@ -1,4 +1,4 @@
NOTES FOR ANDROID PLATFORMS
Notes for Android platforms
===========================
Requirement details


+ 2
- 2
NOTES-DJGPP.md View File

@ -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.


+ 2
- 2
NOTES-UNIX.md View File

@ -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
---------------------------------------------------------------


+ 2
- 2
NOTES-VALGRIND.md View File

@ -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


+ 7
- 7
README.md View File

@ -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.


Loading…
Cancel
Save