From 9f1fe6a950d20fefe9c3477b9b5260609538d7fc Mon Sep 17 00:00:00 2001 From: "Dr. Matthias St. Pierre" Date: Tue, 2 Feb 2021 18:16:19 +0100 Subject: 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 (Merged from https://github.com/openssl/openssl/pull/14042) --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d50114e272..9f64bad686 100644 --- 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-ANDROID.md](NOTES-ANDROID.md) * [NOTES-DJGPP.md](NOTES-DJGPP.md) - * [NOTES-Unix.md](NOTES-Unix.md) + * [NOTES-UNIX.md](NOTES-UNIX.md) * [NOTES-VMS.md](NOTES-VMS.md) - * [NOTES-Windows.txt](NOTES-Windows.txt) - * [NOTES-Perl.md](NOTES-Perl.md) - * [NOTES-Valgrind.md](NOTES-Valgrind.md) + * [NOTES-WINDOWS.md](NOTES-WINDOWS.md) + * [NOTES-PERL.md](NOTES-PERL.md) + * [NOTES-VALGRIND.md](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. -- cgit v1.2.3