doc: deprecation notice to remove octeontx2 drivers

Message ID 20211109155132.3515275-1-jerinj@marvell.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: deprecation notice to remove octeontx2 drivers |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/github-robot: build success github build: passed
ci/iol-spell-check-testing warning Testing issues
ci/iol-mellanox-Performance success Performance Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance 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-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS

Commit Message

Jerin Jacob Kollanukkaran Nov. 9, 2021, 3:51 p.m. UTC
  From: Jerin Jacob <jerinj@marvell.com>

In the view of enabling unified driver for octeontx2(cn9k)/
octeontx3(cn10k), removing drivers/octeontx2 drivers and
replace with drivers/cnxk/ which supports both octeontx2(cn9k)
and octeontx3(cn10k) SoCs.

This deprecation notice is to do following actions in DPDK v22.02
version.
- Replace drivers/common/octeontx2/ with drivers/common/cnxk/
- Replace drivers/mempool/octeontx2/ with drivers/mempool/cnxk/
- Replace drivers/net/octeontx2/ with drivers/net/cnxk/
- Replace drivers/event/octeontx2/ with drivers/event/cnxk/
- Replace drivers/crypto/octeontx2/ with drivers/crypto/cnxk/
- Rename drivers/regex/octeontx2/ as drivers/regex/cn9k/
- Rename config/arm/arm64_octeontx2_linux_gcc as
  config/arm/arm64_cn9k_linux_gcc

Last two actions are to align naming convention as cnxk scheme.

Signed-off-by: Jerin Jacob <jerinj@marvell.com>
---
 doc/guides/rel_notes/deprecation.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
  

Comments

Ferruh Yigit Nov. 9, 2021, 3:58 p.m. UTC | #1
On 11/9/2021 3:51 PM, jerinj@marvell.com wrote:
> From: Jerin Jacob<jerinj@marvell.com>
> 
> In the view of enabling unified driver for octeontx2(cn9k)/
> octeontx3(cn10k), removing drivers/octeontx2 drivers and
> replace with drivers/cnxk/ which supports both octeontx2(cn9k)
> and octeontx3(cn10k) SoCs.
> 
> This deprecation notice is to do following actions in DPDK v22.02
> version.
> - Replace drivers/common/octeontx2/ with drivers/common/cnxk/
> - Replace drivers/mempool/octeontx2/ with drivers/mempool/cnxk/
> - Replace drivers/net/octeontx2/ with drivers/net/cnxk/
> - Replace drivers/event/octeontx2/ with drivers/event/cnxk/
> - Replace drivers/crypto/octeontx2/ with drivers/crypto/cnxk/
> - Rename drivers/regex/octeontx2/ as drivers/regex/cn9k/
> - Rename config/arm/arm64_octeontx2_linux_gcc as
>    config/arm/arm64_cn9k_linux_gcc
> 
> Last two actions are to align naming convention as cnxk scheme.
> 
> Signed-off-by: Jerin Jacob<jerinj@marvell.com>

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
  
Akhil Goyal Nov. 12, 2021, 11:24 a.m. UTC | #2
> On 11/9/2021 3:51 PM, jerinj@marvell.com wrote:
> > From: Jerin Jacob<jerinj@marvell.com>
> >
> > In the view of enabling unified driver for octeontx2(cn9k)/
> > octeontx3(cn10k), removing drivers/octeontx2 drivers and
> > replace with drivers/cnxk/ which supports both octeontx2(cn9k)
> > and octeontx3(cn10k) SoCs.
> >
> > This deprecation notice is to do following actions in DPDK v22.02
> > version.
> > - Replace drivers/common/octeontx2/ with drivers/common/cnxk/
> > - Replace drivers/mempool/octeontx2/ with drivers/mempool/cnxk/
> > - Replace drivers/net/octeontx2/ with drivers/net/cnxk/
> > - Replace drivers/event/octeontx2/ with drivers/event/cnxk/
> > - Replace drivers/crypto/octeontx2/ with drivers/crypto/cnxk/
> > - Rename drivers/regex/octeontx2/ as drivers/regex/cn9k/
> > - Rename config/arm/arm64_octeontx2_linux_gcc as
> >    config/arm/arm64_cn9k_linux_gcc
> >
> > Last two actions are to align naming convention as cnxk scheme.
> >
> > Signed-off-by: Jerin Jacob<jerinj@marvell.com>
> 
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Corresponding documentation would also be removed.
Acked-by: Akhil Goyal <gakhil@marvell.com>
  
Thomas Monjalon Nov. 24, 2021, 3:08 p.m. UTC | #3
12/11/2021 12:24, Akhil Goyal:
> > On 11/9/2021 3:51 PM, jerinj@marvell.com wrote:
> > > From: Jerin Jacob<jerinj@marvell.com>
> > >
> > > In the view of enabling unified driver for octeontx2(cn9k)/
> > > octeontx3(cn10k), removing drivers/octeontx2 drivers and
> > > replace with drivers/cnxk/ which supports both octeontx2(cn9k)
> > > and octeontx3(cn10k) SoCs.
> > >
> > > This deprecation notice is to do following actions in DPDK v22.02
> > > version.
> > > - Replace drivers/common/octeontx2/ with drivers/common/cnxk/
> > > - Replace drivers/mempool/octeontx2/ with drivers/mempool/cnxk/
> > > - Replace drivers/net/octeontx2/ with drivers/net/cnxk/
> > > - Replace drivers/event/octeontx2/ with drivers/event/cnxk/
> > > - Replace drivers/crypto/octeontx2/ with drivers/crypto/cnxk/
> > > - Rename drivers/regex/octeontx2/ as drivers/regex/cn9k/
> > > - Rename config/arm/arm64_octeontx2_linux_gcc as
> > >    config/arm/arm64_cn9k_linux_gcc
> > >
> > > Last two actions are to align naming convention as cnxk scheme.
> > >
> > > Signed-off-by: Jerin Jacob<jerinj@marvell.com>
> > 
> > Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
> Corresponding documentation would also be removed.
> Acked-by: Akhil Goyal <gakhil@marvell.com>

No need to repeat the full notice in the commit message.
I would remove it.

Acked-by: Thomas Monjalon <thomas@monjalon.net>
  
David Marchand Nov. 24, 2021, 3:20 p.m. UTC | #4
On Tue, Nov 9, 2021 at 4:55 PM <jerinj@marvell.com> wrote:
>
> From: Jerin Jacob <jerinj@marvell.com>
>
> In the view of enabling unified driver for octeontx2(cn9k)/
> octeontx3(cn10k), removing drivers/octeontx2 drivers and
> replace with drivers/cnxk/ which supports both octeontx2(cn9k)
> and octeontx3(cn10k) SoCs.
>
> This deprecation notice is to do following actions in DPDK v22.02
> version.
> - Replace drivers/common/octeontx2/ with drivers/common/cnxk/
> - Replace drivers/mempool/octeontx2/ with drivers/mempool/cnxk/
> - Replace drivers/net/octeontx2/ with drivers/net/cnxk/
> - Replace drivers/event/octeontx2/ with drivers/event/cnxk/
> - Replace drivers/crypto/octeontx2/ with drivers/crypto/cnxk/
> - Rename drivers/regex/octeontx2/ as drivers/regex/cn9k/
> - Rename config/arm/arm64_octeontx2_linux_gcc as
>   config/arm/arm64_cn9k_linux_gcc
>
> Last two actions are to align naming convention as cnxk scheme.
>
> Signed-off-by: Jerin Jacob <jerinj@marvell.com>

Acked-by: David Marchand <david.marchand@redhat.com>
  
Thomas Monjalon Nov. 24, 2021, 3:48 p.m. UTC | #5
24/11/2021 16:08, Thomas Monjalon:
> 12/11/2021 12:24, Akhil Goyal:
> > > On 11/9/2021 3:51 PM, jerinj@marvell.com wrote:
> > > > From: Jerin Jacob<jerinj@marvell.com>
> > > >
> > > > In the view of enabling unified driver for octeontx2(cn9k)/
> > > > octeontx3(cn10k), removing drivers/octeontx2 drivers and
> > > > replace with drivers/cnxk/ which supports both octeontx2(cn9k)
> > > > and octeontx3(cn10k) SoCs.
> > > >
> > > > This deprecation notice is to do following actions in DPDK v22.02
> > > > version.
> > > > - Replace drivers/common/octeontx2/ with drivers/common/cnxk/
> > > > - Replace drivers/mempool/octeontx2/ with drivers/mempool/cnxk/
> > > > - Replace drivers/net/octeontx2/ with drivers/net/cnxk/
> > > > - Replace drivers/event/octeontx2/ with drivers/event/cnxk/
> > > > - Replace drivers/crypto/octeontx2/ with drivers/crypto/cnxk/
> > > > - Rename drivers/regex/octeontx2/ as drivers/regex/cn9k/
> > > > - Rename config/arm/arm64_octeontx2_linux_gcc as
> > > >    config/arm/arm64_cn9k_linux_gcc
> > > >
> > > > Last two actions are to align naming convention as cnxk scheme.
> > > >
> > > > Signed-off-by: Jerin Jacob<jerinj@marvell.com>
> > > 
> > > Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
> > Corresponding documentation would also be removed.
> > Acked-by: Akhil Goyal <gakhil@marvell.com>
> 
> No need to repeat the full notice in the commit message.
> I would remove it.
> 
> Acked-by: Thomas Monjalon <thomas@monjalon.net>

Applied
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 6d087c64ef..e730d3e57e 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -119,3 +119,20 @@  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/octeontx2: remove octeontx2 drivers
+
+  In the view of enabling unified driver for ``octeontx2(cn9k)``/``octeontx3(cn10k)``,
+  removing ``drivers/octeontx2`` drivers and replace with ``drivers/cnxk/`` which
+  supports both ``octeontx2(cn9k)`` and ``octeontx3(cn10k)`` SoCs.
+  This deprecation notice is to do following actions in DPDK v22.02 version.
+
+  #. Replace ``drivers/common/octeontx2/`` with ``drivers/common/cnxk/``
+  #. Replace ``drivers/mempool/octeontx2/`` with ``drivers/mempool/cnxk/``
+  #. Replace ``drivers/net/octeontx2/`` with ``drivers/net/cnxk/``
+  #. Replace ``drivers/event/octeontx2/`` with ``drivers/event/cnxk/``
+  #. Replace ``drivers/crypto/octeontx2/`` with ``drivers/crypto/cnxk/``
+  #. Rename ``drivers/regex/octeontx2/`` as ``drivers/regex/cn9k/``
+  #. Rename ``config/arm/arm64_octeontx2_linux_gcc`` as ``config/arm/arm64_cn9k_linux_gcc``
+
+  Last two actions are to align naming convention as cnxk scheme.