[v2,6/6] usertools/setup: move removal target to 21.11

Message ID 20201126141832.2277628-7-ferruh.yigit@intel.com (mailing list archive)
State Rejected, archived
Delegated to: Thomas Monjalon
Headers
Series update dpdk-setup.sh |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/travis-robot success Travis build: passed
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS

Commit Message

Ferruh Yigit Nov. 26, 2020, 2:18 p.m. UTC
  There are still some functions in the script that not replaced
completely, give more time to complete removal of the tool.

A warning added to script documentation about the removal plan.

Current functionality supported by the script is:
 ----------------------------------------------------------
 Step 1: Setup linux environment
 ----------------------------------------------------------
 [1] Insert VFIO module
 [2] Display current Ethernet/Baseband/Crypto device settings
 [3] Bind Ethernet/Baseband/Crypto device to IGB UIO module
 [4] Bind Ethernet/Baseband/Crypto device to VFIO module
 [5] Setup VFIO permissions

 ----------------------------------------------------------
  Step 2: Uninstall and system cleanup
 ----------------------------------------------------------
 [6] Unbind devices from IGB UIO or VFIO driver
 [7] Remove IGB UIO module
 [8] Remove VFIO module
 [9] Remove KNI module

 [10] Exit Script

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
 doc/guides/linux_gsg/quick_start.rst | 4 ++++
 doc/guides/rel_notes/deprecation.rst | 2 +-
 usertools/dpdk-setup.sh              | 2 +-
 3 files changed, 6 insertions(+), 2 deletions(-)
  

Comments

Conor Walsh Nov. 26, 2020, 3:13 p.m. UTC | #1
Hi Ferruh,

Tested V2 patch, the docs also build successfully.

Thanks,
Conor.

> From: Yigit, Ferruh <ferruh.yigit@intel.com>
> Sent: Thursday 26 November 2020 14:19
> To: Thomas Monjalon <thomas@monjalon.net>; Ray Kinsella
> <mdr@ashroe.eu>; Neil Horman <nhorman@tuxdriver.com>
> Cc: Yigit, Ferruh <ferruh.yigit@intel.com>; dev@dpdk.org;
> techboard@dpdk.org; Stephen Hemminger
> <stephen@networkplumber.org>; Richardson, Bruce
> <bruce.richardson@intel.com>; Walsh, Conor <conor.walsh@intel.com>
> Subject: [PATCH v2 6/6] usertools/setup: move removal target to 21.11
> 
> There are still some functions in the script that not replaced
> completely, give more time to complete removal of the tool.
> 
> A warning added to script documentation about the removal plan.
> 
> Current functionality supported by the script is:
>  ----------------------------------------------------------
>  Step 1: Setup linux environment
>  ----------------------------------------------------------
>  [1] Insert VFIO module
>  [2] Display current Ethernet/Baseband/Crypto device settings
>  [3] Bind Ethernet/Baseband/Crypto device to IGB UIO module
>  [4] Bind Ethernet/Baseband/Crypto device to VFIO module
>  [5] Setup VFIO permissions
> 
>  ----------------------------------------------------------
>   Step 2: Uninstall and system cleanup
>  ----------------------------------------------------------
>  [6] Unbind devices from IGB UIO or VFIO driver
>  [7] Remove IGB UIO module
>  [8] Remove VFIO module
>  [9] Remove KNI module
> 
>  [10] Exit Script
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>

Tested-by: Conor Walsh <conor.walsh@intel.com>
  

Patch

diff --git a/doc/guides/linux_gsg/quick_start.rst b/doc/guides/linux_gsg/quick_start.rst
index 630def36a173..ba2decd4b1b5 100644
--- a/doc/guides/linux_gsg/quick_start.rst
+++ b/doc/guides/linux_gsg/quick_start.rst
@@ -6,6 +6,10 @@ 
 Quick Start Setup Script
 ========================
 
+.. warning::
+
+    The dpdk-setup.sh script is deprecated and will be removed in v21.11 release.
+
 The dpdk-setup.sh script, found in the usertools subdirectory, allows the user to perform the following tasks:
 
 *   Insert and remove VFIO kernel modules
diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 96986fabd598..6ad3dafe1bd3 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -103,5 +103,5 @@  Deprecation Notices
 
 * dpdk-setup.sh: This old script relies on deprecated stuff, and especially
   ``make``. Given environments are too much variables for such a simple script,
-  it will be removed in DPDK 20.11.
+  it will be removed in DPDK 21.11.
   Some useful parts may be converted into specific scripts.
diff --git a/usertools/dpdk-setup.sh b/usertools/dpdk-setup.sh
index e8667e094a53..9f24e28c03fd 100755
--- a/usertools/dpdk-setup.sh
+++ b/usertools/dpdk-setup.sh
@@ -289,7 +289,7 @@  while [ "$QUIT" == "0" ]; do
 	OPTIONS[$OPTION_NUM]="quit"
 	echo ""
 	echo '--------------------------------------------------'
-	echo 'WARNING: This tool will be removed from DPDK 20.11'
+	echo 'WARNING: This tool will be removed from DPDK 21.11'
 	echo '--------------------------------------------------'
 	echo
 	echo -n "Option: "