doc: fix release notes for removed testpmd commands

Message ID 20191009134709.1007-1-thomas@monjalon.net
State New
Headers show
Series
  • doc: fix release notes for removed testpmd commands
Related show

Checks

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

Commit Message

Thomas Monjalon Oct. 9, 2019, 1:47 p.m.
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")
Cc: flavia.musatescu@intel.com

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/rel_notes/release_19_11.rst | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

Comments

David Marchand Oct. 9, 2019, 2:57 p.m. | #1
On Wed, Oct 9, 2019 at 3:47 PM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> 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")
> Cc: flavia.musatescu@intel.com
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
>  doc/guides/rel_notes/release_19_11.rst | 19 +++++++++++--------
>  1 file changed, 11 insertions(+), 8 deletions(-)
>
> diff --git a/doc/guides/rel_notes/release_19_11.rst b/doc/guides/rel_notes/release_19_11.rst
> index be91b04ad9..0062e012ed 100644
> --- a/doc/guides/rel_notes/release_19_11.rst
> +++ b/doc/guides/rel_notes/release_19_11.rst
> @@ -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::

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


> +
> +    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 :-)

Reviewed-by: David Marchand <david.marchand@redhat.com>



--
David Marchand

Patch

diff --git a/doc/guides/rel_notes/release_19_11.rst b/doc/guides/rel_notes/release_19_11.rst
index be91b04ad9..0062e012ed 100644
--- a/doc/guides/rel_notes/release_19_11.rst
+++ b/doc/guides/rel_notes/release_19_11.rst
@@ -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