version: 19.11-rc0

Message ID 1565610228-1976-1-git-send-email-david.marchand@redhat.com
State Changes Requested
Delegated to: Thomas Monjalon
Headers show
Series
  • version: 19.11-rc0
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

David Marchand Aug. 12, 2019, 11:43 a.m.
Start a new release cycle with empty release notes.

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
 VERSION                                |   2 +-
 doc/guides/rel_notes/release_19_11.rst | 214 +++++++++++++++++++++++++++++++++
 2 files changed, 215 insertions(+), 1 deletion(-)
 create mode 100644 doc/guides/rel_notes/release_19_11.rst

Comments

Thomas Monjalon Aug. 12, 2019, 11:17 p.m. | #1
12/08/2019 13:43, David Marchand:
> Start a new release cycle with empty release notes.
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
>  VERSION                                |   2 +-
>  doc/guides/rel_notes/release_19_11.rst | 214 +++++++++++++++++++++++++++++++++

doc/guides/rel_notes/release_19_11.rst: WARNING: document isn't included in any toctree

1/ the new file must be linked in doc/guides/rel_notes/index.rst

Please compare with the latest release notes, I see two more misses:
2/ .. include:: <isonum.txt>
3/ increased lib versions

Thanks
David Marchand Aug. 13, 2019, 7:46 a.m. | #2
On Tue, Aug 13, 2019 at 1:17 AM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> 12/08/2019 13:43, David Marchand:
> > Start a new release cycle with empty release notes.
> >
> > Signed-off-by: David Marchand <david.marchand@redhat.com>
> > ---
> >  VERSION                                |   2 +-
> >  doc/guides/rel_notes/release_19_11.rst | 214 +++++++++++++++++++++++++++++++++
>
> doc/guides/rel_notes/release_19_11.rst: WARNING: document isn't included in any toctree

Indeed, trusted your patch on 19.05-rc0 and the CI did not report any
error (normal when it does not actually build the doc ;-)).
I will send a fix for the CI and respin.


> 1/ the new file must be linked in doc/guides/rel_notes/index.rst
>
> Please compare with the latest release notes, I see two more misses:
> 2/ .. include:: <isonum.txt>

It is unused at this point.
Do you want to include it in prevision of future changes?


> 3/ increased lib versions

I'll check.
Thomas Monjalon Aug. 13, 2019, 8:53 a.m. | #3
13/08/2019 09:46, David Marchand:
> On Tue, Aug 13, 2019 at 1:17 AM Thomas Monjalon <thomas@monjalon.net> wrote:
> >
> > 12/08/2019 13:43, David Marchand:
> > > Start a new release cycle with empty release notes.
> > >
> > > Signed-off-by: David Marchand <david.marchand@redhat.com>
> > > ---
> > >  VERSION                                |   2 +-
> > >  doc/guides/rel_notes/release_19_11.rst | 214 +++++++++++++++++++++++++++++++++
> >
> > doc/guides/rel_notes/release_19_11.rst: WARNING: document isn't included in any toctree
> 
> Indeed, trusted your patch on 19.05-rc0 and the CI did not report any
> error (normal when it does not actually build the doc ;-)).

Don't trust anyone ;)

> I will send a fix for the CI and respin.
> 
> 
> > 1/ the new file must be linked in doc/guides/rel_notes/index.rst
> >
> > Please compare with the latest release notes, I see two more misses:
> > 2/ .. include:: <isonum.txt>
> 
> It is unused at this point.
> Do you want to include it in prevision of future changes?

I think it is good to have, so we can use |reg| or other signs
without wondering why it does not work.
I remember Bruce wanted to have it.

> > 3/ increased lib versions
> 
> I'll check.

Thanks

Patch

diff --git a/VERSION b/VERSION
index 909cfd6..fff18fc 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@ 
-19.08.0
+19.11.0-rc0
diff --git a/doc/guides/rel_notes/release_19_11.rst b/doc/guides/rel_notes/release_19_11.rst
new file mode 100644
index 0000000..0bfbf19
--- /dev/null
+++ b/doc/guides/rel_notes/release_19_11.rst
@@ -0,0 +1,214 @@ 
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright 2019 The DPDK contributors
+
+DPDK Release 19.11
+==================
+
+.. **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_19_11.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.
+
+     Suggested order in release notes items:
+     * Core libs (EAL, mempool, ring, mbuf, buses)
+     * Device abstraction libs and PMDs
+       - ethdev (lib, PMDs)
+       - cryptodev (lib, PMDs)
+       - eventdev (lib, PMDs)
+       - etc
+     * Other libs
+     * Apps, Examples, Tools (if significant)
+
+     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.
+   =========================================================
+
+
+API Changes
+-----------
+
+.. This section should contain API changes. Sample format:
+
+   * sample: Add a short 1-2 sentence description of the API change
+     which was announced in the previous releases and made in this release.
+     Start with a scope label like "ethdev:".
+     Use fixed width quotes for ``function_names`` or ``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:
+
+   * sample: Add a short 1-2 sentence description of the ABI change
+     which was announced in the previous releases and made in this release.
+     Start with a scope label like "ethdev:".
+     Use fixed width quotes for ``function_names`` or ``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.
+   =========================================================
+
+
+Shared Library Versions
+-----------------------
+
+.. Update any library version updated in this release
+   and prepend with a ``+`` sign, like this:
+
+     libfoo.so.1
+   + libupdated.so.2
+     libbar.so.1
+
+   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_bpf.so.1
+     librte_bus_dpaa.so.2
+     librte_bus_fslmc.so.2
+     librte_bus_ifpga.so.2
+     librte_bus_pci.so.2
+     librte_bus_vdev.so.2
+     librte_bus_vmbus.so.2
+     librte_cfgfile.so.2
+     librte_cmdline.so.2
+     librte_compressdev.so.1
+     librte_cryptodev.so.7
+     librte_distributor.so.1
+     librte_eal.so.10
+     librte_efd.so.1
+     librte_ethdev.so.12
+     librte_eventdev.so.6
+     librte_flow_classify.so.1
+     librte_gro.so.1
+     librte_gso.so.1
+     librte_hash.so.2
+     librte_ip_frag.so.1
+     librte_ipsec.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.5
+     librte_member.so.1
+     librte_mempool.so.5
+     librte_meter.so.3
+     librte_metrics.so.1
+     librte_net.so.1
+     librte_pci.so.1
+     librte_pdump.so.3
+     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_dpaa2_qdma.so.1
+     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_rcu.so.1
+     librte_reorder.so.1
+     librte_ring.so.2
+     librte_sched.so.2
+     librte_security.so.2
+     librte_stack.so.1
+     librte_table.so.3
+     librte_timer.so.1
+     librte_vhost.so.4
+
+
+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.
+   =========================================================
+
+
+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.
+   =========================================================
+