doc: fix typo in release note
diff mbox series

Message ID 1558428409-29815-1-git-send-email-wang.yong19@zte.com.cn
State Rejected, archived
Delegated to: Thomas Monjalon
Headers show
Series
  • doc: fix typo in release note
Related show

Checks

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

Commit Message

Yong Wang May 21, 2019, 8:46 a.m. UTC
The patch fixes some typoes in 19.02 release note.

Fixes: 6f04df497962 ("doc: add release notes for mlx5")
Fixes: bf9a90e2b562 ("doc: update release notes for 19.02")

Signed-off-by: Yong Wang <wang.yong19@zte.com.cn>
---
 doc/guides/rel_notes/release_19_02.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Comments

Ferruh Yigit May 21, 2019, 2:33 p.m. UTC | #1
On 5/21/2019 9:46 AM, Yong Wang wrote:
> The patch fixes some typoes in 19.02 release note.
> 
> Fixes: 6f04df497962 ("doc: add release notes for mlx5")
> Fixes: bf9a90e2b562 ("doc: update release notes for 19.02")
> 
> Signed-off-by: Yong Wang <wang.yong19@zte.com.cn>

I am not in favor of updating old release notes, I believe the release notes is
valid in the context of the release, so I am for keeping them as they released
(with all their faults).
Although we updated them in the past, and I don't have strong opinion on this,
but lets take this as -1 from my side.

Btw, while thinking perhaps this make sense for stable trees, I don't know if
stable releases has the release notes?
@Kevin, @Luca,
As far as I can see LTS 16.11 & 17.11 updates the release notes with the fixed
commits, but this is not done by 18.11.
And update is only on commits it has, can any release notes update fix be merged
into stable tree?
Kevin Traynor May 21, 2019, 4:30 p.m. UTC | #2
On 21/05/2019 15:33, Ferruh Yigit wrote:
> On 5/21/2019 9:46 AM, Yong Wang wrote:
>> The patch fixes some typoes in 19.02 release note.
>>
>> Fixes: 6f04df497962 ("doc: add release notes for mlx5")
>> Fixes: bf9a90e2b562 ("doc: update release notes for 19.02")
>>
>> Signed-off-by: Yong Wang <wang.yong19@zte.com.cn>
> 
> I am not in favor of updating old release notes, I believe the release notes is
> valid in the context of the release, so I am for keeping them as they released
> (with all their faults).
> Although we updated them in the past, and I don't have strong opinion on this,
> but lets take this as -1 from my side.
> 
> Btw, while thinking perhaps this make sense for stable trees, I don't know if
> stable releases has the release notes?
> @Kevin, @Luca,
> As far as I can see LTS 16.11 & 17.11 updates the release notes with the fixed
> commits, but this is not done by 18.11.
> And update is only on commits it has, can any release notes update fix be merged
> into stable tree?
> 

It's a good question, chatted with Ferruh on IRC. I think mistakes in
the release notes can be backported fine.

The other case is if someone adds a note in 19.05 release notes as part
of a fix that is backported to 18.11. Then it's more tricky because it
won't apply to 18.11 release notes and it is not what was tested in
Tested Platforms from the original release.

One option is to add another additional section for for each stable
release (in addition to the bugfix and validation list) for new notes.

Of course it means manual editing, or dedicated backports, so I'm not
really sure if it's worth the effort or not but it should be a rare event.
Mcnamara, John July 30, 2019, 11:24 a.m. UTC | #3
> -----Original Message-----
> From: Yong Wang [mailto:wang.yong19@zte.com.cn]
> Sent: Tuesday, May 21, 2019 9:47 AM
> To: Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org; Yong Wang <wang.yong19@zte.com.cn>
> Subject: [PATCH] doc: fix typo in release note
> 
> The patch fixes some typoes in 19.02 release note.
> 
> Fixes: 6f04df497962 ("doc: add release notes for mlx5")
> Fixes: bf9a90e2b562 ("doc: update release notes for 19.02")
> 

Acked-by: John McNamara <john.mcnamara@intel.com>

Patch
diff mbox series

diff --git a/doc/guides/rel_notes/release_19_02.rst b/doc/guides/rel_notes/release_19_02.rst
index b353620..0197f29 100644
--- a/doc/guides/rel_notes/release_19_02.rst
+++ b/doc/guides/rel_notes/release_19_02.rst
@@ -103,8 +103,8 @@  New Features
   * Fixed ``imissed`` counter to be reported through ``rte_eth_stats`` instead
     of ``rte_eth_xstats``.
   * Added packet header modification through Direct Verbs flow driver.
-  * Added ConnectX-6 PCI device ID to be proved by ``mlx5`` driver.
-  * Added flow counter support to Direct Verbs flow driver though DevX.
+  * Added ConnectX-6 PCI device ID to be probed by ``mlx5`` driver.
+  * Added flow counter support to Direct Verbs flow driver through DevX.
   * Renamed build options for the glue layer to
     ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` for make and ``ibverbs_link`` for meson.
   * Added static linkage of ``mlx`` dependency.
@@ -135,7 +135,7 @@  New Features
 
   This SW-assisted VDPA live migration facility helps VDPA devices without
   logging capability to perform live migration, a mediated SW relay can help
-  devices to track dirty pages caused by DMA. the IFC driver has enabled this
+  devices to track dirty pages caused by DMA. The IFC driver has enabled this
   SW-assisted live migration mode.
 
 * **Added security checks to the cryptodev symmetric session operations.**
@@ -215,7 +215,7 @@  API Changes
   by the existing ``rte_bsf32`` function.
 
 * eal: Segment fd API on Linux now sets error code to ``ENOTSUP`` in more cases
-  where segment the fd API is not expected to be supported:
+  where the segment fd API is not expected to be supported:
 
   - On attempt to get a segment fd for an externally allocated memory segment
   - In cases where memfd support would have been required to provide segment