Browse Source

Add known issues section

Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22774)
Hugo Landau 5 months ago
parent
commit
4f41334b4a
1 changed files with 16 additions and 0 deletions
  1. 16 0
      dev/NEWS-FORMAT.md

+ 16 - 0
dev/NEWS-FORMAT.md

@@ -133,6 +133,22 @@ possible and practical.
 
 List features in descending order of significance (approximately).
 
+#### Listing known issues
+
+Known issues can be called out as follows:
+
+```text
+The following known issues are present in this release and will be rectified in
+a future release:
+
+    * xxx (#12345)
+
+```
+
+The editorial conventions for this block are similar to those for feature
+additions, except that an issue number is listed rather than a reference to a
+standard.
+
 #### Listing documentation enhancements
 
 Significant documentation enhancements can be called out as follows: