From 228d0c681c9b3e51e2aaf62803771c222653fa43 Mon Sep 17 00:00:00 2001 From: John McNamara Date: Mon, 1 Feb 2016 15:24:47 +0000 Subject: [PATCH] doc: add example text to release notes Added example text to each of the release notes sections to show the preferred format. Signed-off-by: John McNamara --- doc/guides/rel_notes/release_2_3.rst | 58 ++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/doc/guides/rel_notes/release_2_3.rst b/doc/guides/rel_notes/release_2_3.rst index 99de1861a2..53d048d2a1 100644 --- a/doc/guides/rel_notes/release_2_3.rst +++ b/doc/guides/rel_notes/release_2_3.rst @@ -1,13 +1,53 @@ DPDK Release 2.3 ================ + +**Read this first** + +The text below explains how to update the release notes. + +Use proper spelling, capitalization and punctuation in all sections. + +Variable and config names should be quoted as fixed width text: ``LIKE_THIS``. + +Build the docs and view the output file to ensure the changes are correct:: + + make doc-guides-html + + firefox build/doc/html/guides/rel_notes/release_2_3.html + + New Features ------------ +This section should contain new features added in this release. Sample format: + +* **Add a title in the past tense with a full stop.** + + Add a short 1-2 sentence description in the past tense. The description + should be enough to allow someone scanning the release notes to understand + the new feature. + + If the feature adds a lot of sub-features you can use a bullet list like this. + + * Added feature foo to do something. + * Enhanced feature bar to do something else. + + Refer to the previous release notes for examples. + Resolved Issues --------------- +This section should contain bug fixes added to the relevant sections. Sample format: + +* **code/section Fixed issue in the past tense with a full stop.** + + Add a short 1-2 sentence description of the resolved issue in the past tense. + The title should contain the code/lib section like a commit message. + Add the entries in alphabetic order in the relevant sections below. + + EAL ~~~ @@ -31,18 +71,36 @@ Other Known Issues ------------ +This section should contain new known issues in this release. Sample format: + +* **Add title in present tense with full stop.** + + Add a short 1-2 sentence description of the known issue in the present + tense. Add information on any known workarounds. + API Changes ----------- +This section should contain API changes. Sample format: + +* Add a short 1-2 sentence description of the API change. Use fixed width + quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense. + ABI Changes ----------- +* Add a short 1-2 sentence description of the ABI change that was announced in + the previous releases and made in this release. Use fixed width quotes for + ``rte_function_names`` or ``rte_struct_names``. Use the past tense. + Shared Library Versions ----------------------- +Update any library version updated in this release and prepend with a ``+`` sign. + The libraries prepended with a plus sign were incremented in this version. .. code-block:: diff -- 2.20.1