From c50604eb4a6d52b120ea07bad50d3d82a70b26f7 Mon Sep 17 00:00:00 2001
From: "Dr. Matthias St. Pierre" <Matthias.St.Pierre@ncp-e.com>
Date: Tue, 25 Feb 2020 17:04:47 +0100
Subject: [PATCH] doc: add a fancy CHANGES entry to celebrate the new Markdown
format
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10545)
---
CHANGES.md | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/CHANGES.md b/CHANGES.md
index af42a38474..c6d93ef3ed 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -24,6 +24,31 @@ OpenSSL 3.0
### Changes between 1.1.1 and 3.0 [xx XXX xxxx] ###
+
+ * The main project documents (README, NEWS, CHANGES, INSTALL, SUPPORT)
+ have been converted to Markdown with the goal to produce documents
+ which not only look pretty when viewed online in the browser, but
+ remain well readable inside a plain text editor.
+
+ To achieve this goal, a 'minimalistic' Markdown style has been applied
+ which avoids formatting elements that interfere too much with the
+ reading flow in the text file. For example, it
+
+ * avoids [ATX headings][] and uses [setext headings][] instead
+ (which works for `<h1>` and `<h2>` headings only).
+ * avoids [inline links][] and uses [reference links][] instead.
+ * avoids [fenced code blocks][] and uses [indented code blocks][] instead.
+
+ [ATX headings]: https://github.github.com/gfm/#atx-headings
+ [setext headings]: https://github.github.com/gfm/#setext-headings
+ [inline links]: https://github.github.com/gfm/#inline-link
+ [reference links]: https://github.github.com/gfm/#reference-link
+ [fenced code blocks]: https://github.github.com/gfm/#fenced-code-blocks
+ [indented code blocks]: https://github.github.com/gfm/#indented-code-blocks
+
+ *Matthias St. Pierre*
+
+
* The test suite is changed to preserve results of each test recipe.
A new directory test-runs/ with subdirectories named like the
test recipes are created in the build tree for this purpose.
--
2.25.1