From 4f41334b4aee2160c4f292164b7467532402c53b Mon Sep 17 00:00:00 2001 From: Hugo Landau Date: Tue, 21 Nov 2023 12:52:56 +0000 Subject: [PATCH] Add known issues section Reviewed-by: Richard Levitte Reviewed-by: Matt Caswell (Merged from https://github.com/openssl/openssl/pull/22774) --- dev/NEWS-FORMAT.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/dev/NEWS-FORMAT.md b/dev/NEWS-FORMAT.md index f856f78127..9807c41bad 100644 --- a/dev/NEWS-FORMAT.md +++ b/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: