From: "Carrillo, Erik G" <erik.g.carrillo@intel.com>
To: "Mcnamara, John" <john.mcnamara@intel.com>,
"dev@dpdk.org" <dev@dpdk.org>
Cc: "Mcnamara, John" <john.mcnamara@intel.com>
Subject: Re: [dpdk-dev] [PATCH v1] doc: add template release notes for 18.05
Date: Fri, 16 Feb 2018 22:54:48 +0000 [thread overview]
Message-ID: <BE54F058557D9A4FAC1D84E2FC6D87570EDC2707@fmsmsx115.amr.corp.intel.com> (raw)
In-Reply-To: <1518699848-336-1-git-send-email-john.mcnamara@intel.com>
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of John McNamara
> Sent: Thursday, February 15, 2018 7:04 AM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>
> Subject: [dpdk-dev] [PATCH v1] doc: add template release notes for 18.05
>
> Add template release notes for DPDK 18.05 with inline comments and
> explanations of the various sections.
>
> Signed-off-by: John McNamara <john.mcnamara@intel.com>
> ---
> doc/guides/rel_notes/release_18_05.rst | 187
> +++++++++++++++++++++++++++++++++
> 1 file changed, 187 insertions(+)
> create mode 100644 doc/guides/rel_notes/release_18_05.rst
>
> diff --git a/doc/guides/rel_notes/release_18_05.rst
> b/doc/guides/rel_notes/release_18_05.rst
> new file mode 100644
> index 0000000..85f4dc5
> --- /dev/null
> +++ b/doc/guides/rel_notes/release_18_05.rst
> @@ -0,0 +1,187 @@
> +DPDK Release 18.05
> +==================
> +
> +.. **Read this first.**
> +
> + The text in the sections 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
> +
> + xdg-open build/doc/html/guides/rel_notes/release_18_05.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.
> +
> + This section is a comment. Do not overwrite or remove it.
> + Also, make sure to start the actual text at the margin.
> +
> =========================================================
> +
> +
> +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.
> +
> + This section is a comment. Do not overwrite or remove it.
> + Also, make sure to start the actual text at the margin.
> +
> =========================================================
> +
> +
> +ABI Changes
> +-----------
> +
> +.. This section should contain ABI changes. Sample format:
> +
> + * 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.
> +
> + This section is a comment. Do not overwrite or remove it.
> + Also, make sure to start the actual text at the margin.
> +
> =========================================================
> +
> +
> +Removed Items
> +-------------
> +
> +.. This section should contain removed items in this release. Sample format:
> +
> + * Add a short 1-2 sentence description of the removed item in the past
> + tense.
> +
> + This section is a comment. Do not overwrite or remove it.
> + Also, make sure to start the actual text at the margin.
> +
> =========================================================
> +
> +
> +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.
> +
> + This section is a comment. Do not overwrite or remove it.
> + Also, make sure to start the actual text at the margin.
> +
> =========================================================
> +
> +
> +Shared Library Versions
> +-----------------------
> +
> +.. Update any library version updated in this release and prepend with a ``+``
> + sign, like this:
> +
> + librte_acl.so.2
> + + librte_cfgfile.so.2
> + librte_cmdline.so.2
> +
> + This section is a comment. Do not overwrite or remove it.
> +
> =========================================================
> +
> +
> +The libraries prepended with a plus sign were incremented in this version.
> +
> +.. code-block:: diff
> +
> + librte_acl.so.2
> + librte_bbdev.so.1
> + librte_bitratestats.so.2
> + librte_bus_dpaa.so.1
> + librte_bus_fslmc.so.1
> + librte_bus_pci.so.1
> + librte_bus_vdev.so.1
> + librte_cfgfile.so.2
> + librte_cmdline.so.2
> + librte_cryptodev.so.4
> + librte_distributor.so.1
> + librte_eal.so.6
> + librte_ethdev.so.8
> + librte_eventdev.so.3
> + librte_flow_classify.so.1
> + librte_gro.so.1
> + librte_gso.so.1
> + librte_hash.so.2
> + librte_ip_frag.so.1
> + librte_jobstats.so.1
> + librte_kni.so.2
> + librte_kvargs.so.1
> + librte_latencystats.so.1
> + librte_lpm.so.2
> + librte_mbuf.so.3
> + librte_mempool.so.3
> + librte_meter.so.1
> + librte_metrics.so.1
> + librte_net.so.1
> + librte_pci.so.1
> + librte_pdump.so.2
> + librte_pipeline.so.3
> + librte_pmd_bnxt.so.2
> + librte_pmd_bond.so.2
> + librte_pmd_i40e.so.2
> + librte_pmd_ixgbe.so.2
> + librte_pmd_ring.so.2
> + librte_pmd_softnic.so.1
> + librte_pmd_vhost.so.2
> + librte_port.so.3
> + librte_power.so.1
> + librte_rawdev.so.1
> + librte_reorder.so.1
> + librte_ring.so.1
> + librte_sched.so.1
> + librte_security.so.1
> + librte_table.so.3
> + librte_timer.so.1
> + librte_vhost.so.3
> +
> +
> +Tested Platforms
> +----------------
> +
> +.. This section should contain a list of platforms that were tested with this
> + release.
> +
> + The format is:
> +
> + * <vendor> platform with <vendor> <type of devices> combinations
> +
> + * List of CPU
> + * List of OS
> + * List of devices
> + * Other relevant details...
> +
> + This section is a comment. Do not overwrite or remove it.
> + Also, make sure to start the actual text at the margin.
> +
> =========================================================
> --
> 2.7.5
Acked-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
next prev parent reply other threads:[~2018-02-16 22:54 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-02-15 13:04 John McNamara
2018-02-16 22:54 ` Carrillo, Erik G [this message]
2018-02-19 20:47 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=BE54F058557D9A4FAC1D84E2FC6D87570EDC2707@fmsmsx115.amr.corp.intel.com \
--to=erik.g.carrillo@intel.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).