doc: announce CRC strip changes in release notes

Message ID 20180924173140.83312-1-ferruh.yigit@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series doc: announce CRC strip changes in release notes |

Checks

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

Commit Message

Ferruh Yigit Sept. 24, 2018, 5:31 p.m. UTC
  Document changes done in
commit 323e7b667f18 ("ethdev: make default behavior CRC strip on Rx")

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
 doc/guides/rel_notes/release_18_11.rst | 6 ++++++
 1 file changed, 6 insertions(+)
  

Comments

Thomas Monjalon Sept. 24, 2018, 5:01 p.m. UTC | #1
24/09/2018 19:31, Ferruh Yigit:
> Document changes done in
> commit 323e7b667f18 ("ethdev: make default behavior CRC strip on Rx")
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> ---
> --- a/doc/guides/rel_notes/release_18_11.rst
> +++ b/doc/guides/rel_notes/release_18_11.rst
> @@ -112,6 +112,12 @@ API Changes
> +* The default behaviour of CRC strip offload changed. Without any specific Rx
> +  offload flag, default behavior by PMD is now to strip CRC.
> +  DEV_RX_OFFLOAD_CRC_STRIP offload flag has been removed.
> +  To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC`` Rx
> +  offload.

Acked-by: Thomas Monjalon <thomas@monjalon.net>

Thanks
  
David Marchand Sept. 24, 2018, 5:12 p.m. UTC | #2
On Mon, Sep 24, 2018 at 7:31 PM, Ferruh Yigit <ferruh.yigit@intel.com> wrote:
> Document changes done in
> commit 323e7b667f18 ("ethdev: make default behavior CRC strip on Rx")
>
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> ---
>  doc/guides/rel_notes/release_18_11.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
>
> diff --git a/doc/guides/rel_notes/release_18_11.rst b/doc/guides/rel_notes/release_18_11.rst
> index 2f53564a9..41b9cd8d5 100644
> --- a/doc/guides/rel_notes/release_18_11.rst
> +++ b/doc/guides/rel_notes/release_18_11.rst
> @@ -112,6 +112,12 @@ API Changes
>    flag the MAC can be properly configured in any case. This is particularly
>    important for bonding.
>
> +* The default behaviour of CRC strip offload changed. Without any specific Rx
> +  offload flag, default behavior by PMD is now to strip CRC.
> +  DEV_RX_OFFLOAD_CRC_STRIP offload flag has been removed.
> +  To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC`` Rx
> +  offload.
> +
>
>  ABI Changes
>  -----------

Reviewed-by: David Marchand <david.marchand@6wind.com>
  
Ferruh Yigit Sept. 25, 2018, 3:03 p.m. UTC | #3
On 9/24/2018 6:12 PM, David Marchand wrote:
> On Mon, Sep 24, 2018 at 7:31 PM, Ferruh Yigit <ferruh.yigit@intel.com> wrote:
>> Document changes done in
>> commit 323e7b667f18 ("ethdev: make default behavior CRC strip on Rx")
>>
>> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>

Acked-by: Thomas Monjalon <thomas@monjalon.net>

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

Applied to dpdk-next-net/master, thanks.
  

Patch

diff --git a/doc/guides/rel_notes/release_18_11.rst b/doc/guides/rel_notes/release_18_11.rst
index 2f53564a9..41b9cd8d5 100644
--- a/doc/guides/rel_notes/release_18_11.rst
+++ b/doc/guides/rel_notes/release_18_11.rst
@@ -112,6 +112,12 @@  API Changes
   flag the MAC can be properly configured in any case. This is particularly
   important for bonding.
 
+* The default behaviour of CRC strip offload changed. Without any specific Rx
+  offload flag, default behavior by PMD is now to strip CRC.
+  DEV_RX_OFFLOAD_CRC_STRIP offload flag has been removed.
+  To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC`` Rx
+  offload.
+
 
 ABI Changes
 -----------