doc: announce rename of octeontx_ep driver

Message ID 20220630185532.29389-1-vburru@marvell.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series doc: announce rename of octeontx_ep driver |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Veerasenareddy Burru June 30, 2022, 6:55 p.m. UTC
  To enable single unified driver to support current OcteonTx and
future Octeon PCI endpoint NICs, octeontx_ep driver is renamed to
octeon_ep to reflect common driver for all Octeon based
PCI endpoint NICs.

Signed-off-by: Veerasenareddy Burru <vburru@marvell.com>
---
 doc/guides/rel_notes/deprecation.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
  

Comments

Jerin Jacob July 11, 2022, 3:01 p.m. UTC | #1
On Fri, Jul 1, 2022 at 1:40 PM Veerasenareddy Burru <vburru@marvell.com> wrote:
>
> To enable single unified driver to support current OcteonTx and
> future Octeon PCI endpoint NICs, octeontx_ep driver is renamed to
> octeon_ep to reflect common driver for all Octeon based
> PCI endpoint NICs.
>
> Signed-off-by: Veerasenareddy Burru <vburru@marvell.com>


Acked-by: Jerin Jacob <jerinj@marvell.com>

> ---
>  doc/guides/rel_notes/deprecation.rst | 9 +++++++++
>  1 file changed, 9 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 4e5b23c53d..d50e68aed4 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -125,3 +125,12 @@ Deprecation Notices
>    applications should be updated to use the ``dmadev`` library instead,
>    with the underlying HW-functionality being provided by the ``ioat`` or
>    ``idxd`` dma drivers
> +
> +* drivers/octeontx_ep: rename octeontx_ep drivers
> +
> +  Current driver name "octeontx_ep" was to support OcteonTX line of products.
> +  This is renamed to apply for all Octeon EP products:
> +  OcteonTX + future Octeon chipsets.
> +  This deprecation notice is to do following actions in DPDK v22.11 version.
> +
> +  #. Rename ``drivers/net/octeontx_ep/`` to ``drivers/net/octeon_ep/``
> --
> 2.36.0
>
  
Thomas Monjalon July 12, 2022, 2:09 p.m. UTC | #2
30/06/2022 20:55, Veerasenareddy Burru:
> To enable single unified driver to support current OcteonTx and
> future Octeon PCI endpoint NICs, octeontx_ep driver is renamed to
> octeon_ep to reflect common driver for all Octeon based
> PCI endpoint NICs.
> 
> Signed-off-by: Veerasenareddy Burru <vburru@marvell.com>
> ---
> +* drivers/octeontx_ep: rename octeontx_ep drivers

It is only one driver, right?

> +  Current driver name "octeontx_ep" was to support OcteonTX line of products.
> +  This is renamed to apply for all Octeon EP products:

It should be in future: "It will be renamed"

> +  OcteonTX + future Octeon chipsets.
> +  This deprecation notice is to do following actions in DPDK v22.11 version.

No need this last sentence.

With better wording, I would ack.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 4e5b23c53d..d50e68aed4 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -125,3 +125,12 @@  Deprecation Notices
   applications should be updated to use the ``dmadev`` library instead,
   with the underlying HW-functionality being provided by the ``ioat`` or
   ``idxd`` dma drivers
+
+* drivers/octeontx_ep: rename octeontx_ep drivers
+
+  Current driver name "octeontx_ep" was to support OcteonTX line of products.
+  This is renamed to apply for all Octeon EP products:
+  OcteonTX + future Octeon chipsets.
+  This deprecation notice is to do following actions in DPDK v22.11 version.
+
+  #. Rename ``drivers/net/octeontx_ep/`` to ``drivers/net/octeon_ep/``