diff options
author | Dr. Matthias St. Pierre <matthias.st.pierre@ncp-e.com> | 2021-02-02 18:16:19 +0100 |
---|---|---|
committer | Dr. Matthias St. Pierre <matthias.st.pierre@ncp-e.com> | 2021-02-12 20:35:26 +0100 |
commit | 9f1fe6a950d20fefe9c3477b9b5260609538d7fc (patch) | |
tree | c3f52287a6056c4180786ee8dc8b7ee679ffc08c /INSTALL.md | |
parent | ssl_test: Add testcases for disallowing non-TLS1.3 curves with TLS1.3 (diff) | |
download | openssl-9f1fe6a950d20fefe9c3477b9b5260609538d7fc.tar.xz openssl-9f1fe6a950d20fefe9c3477b9b5260609538d7fc.zip |
Revise some renamings of NOTES and README files
Some of the notes and readme files have been converted to markdown
format recently and renamed during this process. While adding the
.md extension was a natural step, switching to mixed cases was not
a change to the better, it gives them a ragged appearance:
NOTES.ANDROID => NOTES-Android.md
NOTES.DJGPP => NOTES-DJGPP.md
NOTES.PERL => NOTES-Perl.md
NOTES.UNIX => NOTES-Unix.md
NOTES.VMS => NOTES-VMS.md
NOTES.VALGRIND => NOTES-Valgrind.md
NOTES.WIN => NOTES-Windows.txt
README.ENGINE => README-Engine.md
README.FIPS => README-FIPS.md
Moreover, the NOTES-Windows.txt file is the only file which has been
converted to markdown but has received a .txt file extension.
This doesn't make sense, because the OpenSSL users on Windows will
need to read the other markdown documents as well. Since they are
developers, we can trust them to be able to associate their favorite
editor with the .md extension.
In fact, having a comment at the beginning of the file saying that it
is in markdown format but we didn't dare to add the correct extension
in order not to overwhelm our Windows users can be interpreted either
as unintentionally funny or disrespectful ;-)
This commit suggests the following more consistent renaming:
NOTES.ANDROID => NOTES-ANDROID.md
NOTES.DJGPP => NOTES-DJGPP.md
NOTES.PERL => NOTES-PERL.md
NOTES.UNIX => NOTES-UNIX.md
NOTES.VMS => NOTES-VMS.md
NOTES.VALGRIND => NOTES-VALGRIND.md
NOTES.WIN => NOTES-WINDOWS.md
README.ENGINE => README-ENGINES.md
README.FIPS => README-FIPS.md
(note the plural in README-ENGINES, anticipating a README-PROVIDERS)
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14042)
Diffstat (limited to 'INSTALL.md')
-rw-r--r-- | INSTALL.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/INSTALL.md b/INSTALL.md index eec2f3a2b3..0d9665999a 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -48,8 +48,8 @@ Prerequisites To install OpenSSL, you will need: * A "make" implementation - * Perl 5 with core modules (please read [NOTES-Perl.md](NOTES-Perl.md)) - * The Perl module `Text::Template` (please read [NOTES-PERL.md](NOTES-Perl.md)) + * Perl 5 with core modules (please read [NOTES-PERL.md](NOTES-PERL.md)) + * The Perl module `Text::Template` (please read [NOTES-PERL.md](NOTES-PERL.md)) * an ANSI C compiler * a development environment in the form of development libraries and C header files @@ -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-UNIX.md](NOTES-UNIX.md) - notes for Unix like systems * [NOTES-VMS.md](NOTES-VMS.md) - notes related to OpenVMS - * [NOTES-Windows.txt](NOTES-Windows.txt) - notes related to the Windows platform + * [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-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 Notational conventions ====================== @@ -285,7 +285,7 @@ Configuration Options There are several options to `./Configure` to customize the build (note that for Windows, the defaults for `--prefix` and `--openssldir` depend on what configuration is used and what Windows implementation OpenSSL is built on. -More notes on this in [NOTES-Windows.txt](NOTES-Windows.txt): +For more information, see the [Notes for Windows platforms](NOTES-WINDOWS.md). API Level --------- |