diff options
| author | Hugo Landau <hlandau@openssl.org> | 2023-11-21 13:52:56 +0100 |
|---|---|---|
| committer | Hugo Landau <hlandau@openssl.org> | 2023-11-29 09:35:17 +0100 |
| commit | 4f41334b4aee2160c4f292164b7467532402c53b (patch) | |
| tree | 6058a02d73b45315c1a8384c5fd7775a5f9c0941 /dev | |
| parent | Add proposed editorial conventions for NEWS.md (diff) | |
| download | openssl-4f41334b4aee2160c4f292164b7467532402c53b.tar.xz openssl-4f41334b4aee2160c4f292164b7467532402c53b.zip | |
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)
Diffstat (limited to 'dev')
| -rw-r--r-- | dev/NEWS-FORMAT.md | 16 |
1 files changed, 16 insertions, 0 deletions
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: |