Skip to contentSkip to conversation

doc: fix release notes for removed testpmd commands

PATCH Applied Thomas Monjalon 2 participants 3 messages Oct 9, 2019 – Oct 24, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: fix release notes for removed testpmd commands

The notes were not visible in the generated doc output because of an indentation mistake.
While fixing the indentation, the formatting is improved.

Fixes e5db17a1e54e ("app/testpmd: remove duplicated Rx offload commands")
---
 doc/guides/rel_notes/release_19_11.rst | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)
doc/guides/rel_notes/release_19_11.rst +11 -8
index be91b04ad9..0062e012ed 100644
@@ -91,14 +91,17 @@ Removed Items
    Also, make sure to start the actual text at the margin.
    =========================================================
 
-   * Removed duplicated set of commands for RX offloading configuration from app/testpmd:
-     “port config all crc-strip|scatter|rx-cksum|rx-timestamp|hw-vlan|hw-vlan-filter|
-     hw-vlan-strip|hw-vlan-extend on|off”.
-
-     The testpmd commands set that can be used instead in order to enable or disable Rx
-     offloading on all Rx queues of a port is:
-     "port config <port_id> rx_offload crc_strip|scatter|ipv4_cksum|udp_cksum|tcp_cksum|
-     timestamp|vlan_strip|vlan_filter|vlan_extend on|off"
+* Removed duplicated set of commands for Rx offload configuration from testpmd::
+
+    port config all crc-strip|scatter|rx-cksum|rx-timestamp|
+                    hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
+
+  The testpmd commands set that can be used instead
+  in order to enable or disable Rx offloading on all Rx queues of a port is::
+
+    port config <port_id> rx_offload crc_strip|scatter|
+                                     ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
+                                     vlan_strip|vlan_filter|vlan_extend on|off
 
 
 API Changes
Signature · 1 line
2.23.0
Reviewed-by on v1 1/1
#1 lore raw
Quoted 26 lines · Thomas Monjalon

The notes were not visible in the generated doc output because of an indentation mistake.
While fixing the indentation, the formatting is improved.

Fixes e5db17a1e54e ("app/testpmd: remove duplicated Rx offload commands")
---
 doc/guides/rel_notes/release_19_11.rst | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)
doc/guides/rel_notes/release_19_11.rst +0 -5
index be91b04ad9..0062e012ed 100644
@@ -91,14 +91,17 @@ Removed Items
    Also, make sure to start the actual text at the margin.
    =========================================================
 
-   * Removed duplicated set of commands for RX offloading configuration from app/testpmd:
-     “port config all crc-strip|scatter|rx-cksum|rx-timestamp|hw-vlan|hw-vlan-filter|
-     hw-vlan-strip|hw-vlan-extend on|off”.
-
-     The testpmd commands set that can be used instead in order to enable or disable Rx

doc/guides/rel_notes/release_19_11.rst Removed Items · line 100

Quoted 10 lines
doc/guides/rel_notes/release_19_11.rst +7 -3
-     offloading on all Rx queues of a port is:
-     "port config <port_id> rx_offload crc_strip|scatter|ipv4_cksum|udp_cksum|tcp_cksum|
-     timestamp|vlan_strip|vlan_filter|vlan_extend on|off"
+* Removed duplicated set of commands for Rx offload configuration from testpmd::
+
+    port config all crc-strip|scatter|rx-cksum|rx-timestamp|
+                    hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
+
+  The testpmd commands set that can be used instead
+  in order to enable or disable Rx offloading on all Rx queues of a port is::

A bit hard to digest: "can be used instead in order to". Might be worth some proofreading, John?

doc/guides/rel_notes/release_19_11.rst Removed Items · line 107

Quoted 7 lines
doc/guides/rel_notes/release_19_11.rst +4 -0
+
+    port config <port_id> rx_offload crc_strip|scatter|
+                                     ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
+                                     vlan_strip|vlan_filter|vlan_extend on|off
 
 
 API Changes

But at least the generated doc now contains something :-)

--
David Marchand

#2 lore raw
Quoted 7 lines · David Marchand
Quoted 5 lines · Thomas Monjalon

The notes were not visible in the generated doc output because of an indentation mistake.
While fixing the indentation, the formatting is improved.

Quoted 5 lines
Quoted 4 lines
Fixes e5db17a1e54e ("app/testpmd: remove duplicated Rx offload commands")

Applied, thanks.

Signature · 1 line
David Marchand