]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
Add known issues section
authorHugo Landau <hlandau@openssl.org>
Tue, 21 Nov 2023 12:52:56 +0000 (12:52 +0000)
committerHugo Landau <hlandau@openssl.org>
Wed, 29 Nov 2023 08:35:17 +0000 (08:35 +0000)
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22774)

dev/NEWS-FORMAT.md

index f856f7812724934f78d4419195d936aeea82f5cf..9807c41bad2899b4fce195e19f533db47b799fbe 100644 (file)
@@ -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: