[4/4] doc: replace use of ifconfig in nics

Message ID 20240402163050.133923-5-stephen@networkplumber.org (mailing list archive)
State New
Delegated to: Thomas Monjalon
Headers
Series Replace references to ifconfig in doc |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/github-robot: build success github build: passed
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Functional success Functional Testing PASS

Commit Message

Stephen Hemminger April 2, 2024, 4:29 p.m. UTC
  The ifconfig command is BSD legacy and no longer maintained.
Replace it with modern (20 year old) ip command.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/nics/bnx2x.rst   |  4 ++--
 doc/guides/nics/cxgbe.rst   | 13 ++++++-------
 doc/guides/nics/e1000em.rst |  2 +-
 doc/guides/nics/i40e.rst    |  2 +-
 doc/guides/nics/mlx5.rst    |  2 +-
 doc/guides/nics/qede.rst    |  4 ++--
 6 files changed, 13 insertions(+), 14 deletions(-)
  

Patch

diff --git a/doc/guides/nics/bnx2x.rst b/doc/guides/nics/bnx2x.rst
index c24d32b9ab..ed56756a3f 100644
--- a/doc/guides/nics/bnx2x.rst
+++ b/doc/guides/nics/bnx2x.rst
@@ -163,8 +163,8 @@  This section provides instructions to configure SR-IOV with Linux OS.
 
    .. code-block:: console
 
-      ifconfig ens5f0 up
-      ifconfig ens5f1 up
+      ip link set dev ens5f0 up
+      ip link set dev ens5f1 up
 
 #. Create VF device(s):
 
diff --git a/doc/guides/nics/cxgbe.rst b/doc/guides/nics/cxgbe.rst
index 1f0b848ede..7cdaddeeb8 100644
--- a/doc/guides/nics/cxgbe.rst
+++ b/doc/guides/nics/cxgbe.rst
@@ -344,11 +344,11 @@  Unified Wire package for Linux operating system are as follows:
 
       modprobe cxgb4
 
-#. Use ifconfig to get the interface name assigned to Chelsio card:
+#. Use ip to get the interface name assigned to Chelsio card:
 
    .. code-block:: console
 
-      ifconfig -a | grep "00:07:43"
+      ip -br link show | grep "00:07:43"
 
    Example output:
 
@@ -502,11 +502,11 @@  virtual functions.
       Both the interfaces of a Chelsio 2-port adapter are bound to the
       same PCI bus address.
 
-#. Use ifconfig to get the interface name assigned to Chelsio card:
+#. Use ip to get the interface name assigned to Chelsio card:
 
    .. code-block:: console
 
-      ifconfig -a | grep "00:07:43"
+      ip -br link show | grep "00:07:43"
 
    Example output:
 
@@ -519,8 +519,8 @@  virtual functions.
 
    .. code-block:: console
 
-      ifconfig p1p1 up
-      ifconfig p1p2 up
+      ip link set dev p1p1 up
+      ip link set dev p1p2 up
 
 #. Instantiate SR-IOV Virtual Functions. PF0..3 can be used for
    SR-IOV VFs. Multiple VFs can be instantiated on each of PF0..3.
@@ -886,4 +886,3 @@  port.
 
 For this reason, one cannot allow/block a single port without
 allowing/blocking the other ports on the same device.
-
diff --git a/doc/guides/nics/e1000em.rst b/doc/guides/nics/e1000em.rst
index 5e752a29e5..b4ba132144 100644
--- a/doc/guides/nics/e1000em.rst
+++ b/doc/guides/nics/e1000em.rst
@@ -125,7 +125,7 @@  The setup procedure is as follows:
             tapvm01: tap
             tapvm02: tap
 
-#.  Configure your TAP networking interfaces using ip/ifconfig tools.
+#.  Configure your TAP networking interfaces using iproute2 tools.
 
 #.  Log in to the guest OS and check that the expected emulated devices exist:
 
diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index ca6caa0cff..f80e173c44 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -326,7 +326,7 @@  SR-IOV: Prerequisites and sample Application Notes
 
    .. code-block:: console
 
-      ifconfig ens802f0 up
+      ip link set dev ens802f0 up
 
 #. Create VF device(s):
 
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 9b2fe07fd3..1863c1ab7f 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -86,7 +86,7 @@  operations such as querying/updating the MTU and flow control parameters.
 This capability allows the PMD to coexist with kernel network interfaces
 which remain functional, although they stop receiving unicast packets as
 long as they share the same MAC address.
-This means legacy linux control tools (for example: ethtool, ifconfig and
+This means legacy linux control tools (for example: ethtool, iproute and
 more) can operate on the same network interfaces that owned by the DPDK
 application.
 
diff --git a/doc/guides/nics/qede.rst b/doc/guides/nics/qede.rst
index 38d5cbb1f3..9f65470179 100644
--- a/doc/guides/nics/qede.rst
+++ b/doc/guides/nics/qede.rst
@@ -226,8 +226,8 @@  This section provides instructions to configure SR-IOV with Linux OS.
 
    .. code-block:: console
 
-      ifconfig ens5f0 up
-      ifconfig ens5f1 up
+      ip link set dev ens5f0 up
+      ip link set dev ens5f1 up
 
 #. Create VF device(s):