[PATCH 0/4] Replace references to ifconfig in doc

[PATCH 0/4] Replace references to ifconfig in doc

[Stephen Hemminger]

Replace references to ifconfig in documentation.
The ifconfig command is deprecated and has been replaced by
iproute2 for 20 years.

Stephen Hemminger (4):
  doc: remove references to ifconfig
  doc: replace ifconfig and brctl usage in howto
  doc: replace ifconfig in testpmd doc
  doc: replace use of ifconfig in nics

 doc/guides/howto/lm_bond_virtio_sriov.rst   | 58 ++++++++++-----------
 doc/guides/howto/lm_virtio_vhost_user.rst   |  2 +-
 doc/guides/linux_gsg/linux_drivers.rst      |  2 +-
 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 +-
 doc/guides/testpmd_app_ug/testpmd_funcs.rst |  3 +-
 10 files changed, 46 insertions(+), 46 deletions(-)

-- 
2.43.0

[PATCH 1/4] doc: remove references to ifconfig

[Stephen Hemminger]

The ifconfig command is legacy and may not be supported in
some distributions in future. Replace by current ip command
in the documentation.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/linux_gsg/linux_drivers.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst
index 852a60f5c0..7f53ca3bae 100644
--- a/doc/guides/linux_gsg/linux_drivers.rst
+++ b/doc/guides/linux_gsg/linux_drivers.rst
@@ -375,7 +375,7 @@ Such model has the following benefits:
  - It is secure and robust, as the memory management and isolation
    is done by the kernel.
  - It enables the user to use legacy linux tools such as ``ethtool`` or
-   ``ifconfig`` while running DPDK application on the same network ports.
+   ``ip`` while running DPDK application on the same network ports.
  - It enables the DPDK application to filter only part of the traffic,
    while the rest will be directed and handled by the kernel driver.
    The flow bifurcation is performed by the NIC hardware.
-- 
2.43.0

[PATCH 2/4] doc: replace ifconfig and brctl usage in howto

[Stephen Hemminger]

The brctl command is deprecated and not supported on lastest
distros. Ifconfig command is legacy and no longer maintained;
replace it with ip commands in documentation.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/howto/lm_bond_virtio_sriov.rst | 58 +++++++++++------------
 doc/guides/howto/lm_virtio_vhost_user.rst |  2 +-
 2 files changed, 30 insertions(+), 30 deletions(-)

diff --git a/doc/guides/howto/lm_bond_virtio_sriov.rst b/doc/guides/howto/lm_bond_virtio_sriov.rst
index 60b4462c2c..751b1de90b 100644
--- a/doc/guides/howto/lm_bond_virtio_sriov.rst
+++ b/doc/guides/howto/lm_bond_virtio_sriov.rst
@@ -445,21 +445,21 @@ Setup bridge on host_server_1
    # ens3f0 is the Niantic NIC
    # ens6f0 is the Fortville NIC
 
-   ifconfig ens3f0 down
-   ifconfig tap1 down
-   ifconfig ens6f0 down
-   ifconfig virbr0 down
-
-   brctl show virbr0
-   brctl addif virbr0 ens3f0
-   brctl addif virbr0 ens6f0
-   brctl addif virbr0 tap1
-   brctl show virbr0
-
-   ifconfig ens3f0 up
-   ifconfig tap1 up
-   ifconfig ens6f0 up
-   ifconfig virbr0 up
+   ip link set dev ens3f0 down
+   ip link set dev tap1 down
+   ip link set dev ens6f0 down
+   ip link set dev virbr0 down
+
+   bridge link show dev virbr0
+   ip link set dev ens3f0 master virbr0
+   ip link set dev ens6f0 master virbr0
+   ip link set dev tap1 master virbr0
+   bridge link show dev virbr0
+
+   ip link set dev ens3f0 up
+   ip link set dev tap1 up
+   ip link set dev ens6f0 up
+   ip link set dev virbr0 up
 
 connect_to_qemu_mon_on_host.sh
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -548,21 +548,21 @@ Setup bridge on host_server_2
    # ens4f0 is the Niantic NIC
    # ens5f0 is the Fortville NIC
 
-   ifconfig ens4f0 down
-   ifconfig tap1 down
-   ifconfig ens5f0 down
-   ifconfig virbr0 down
+   ip link set dev ens4f0 down
+   ip link set dev tap1 down
+   ip link set dev ens5f0 down
+   ip link set dev virbr0 down
 
-   brctl show virbr0
-   brctl addif virbr0 ens4f0
-   brctl addif virbr0 ens5f0
-   brctl addif virbr0 tap1
-   brctl show virbr0
+   bridge link show dev virbr0
+   ip link set dev ens4f0 master virbr0
+   ip link set dev ens5f0 master virbr0
+   ip link set dev tap1 master virbr0
+   bridge link show dev virbr0
 
-   ifconfig ens4f0 up
-   ifconfig tap1 up
-   ifconfig ens5f0 up
-   ifconfig virbr0 up
+   ip link set dev ens4f0 up
+   ip link set dev tap1 up
+   ip link set dev ens5f0 up
+   ip link set dev virbr0 up
 
 .. _lm_bond_virtio_sriov_vm_scripts:
 
@@ -585,7 +585,7 @@ Set up DPDK in the Virtual Machine
    /root/dpdk/usertools/dpdk-hugepages.py --setup 2G
    /root/dpdk/usertools/dpdk-hugepages.py --show
 
-   ifconfig -a
+   ip link show
    /root/dpdk/usertools/dpdk-devbind.py --status
 
    rmmod virtio-pci ixgbevf
diff --git a/doc/guides/howto/lm_virtio_vhost_user.rst b/doc/guides/howto/lm_virtio_vhost_user.rst
index c5c48f10a9..2f9a93e849 100644
--- a/doc/guides/howto/lm_virtio_vhost_user.rst
+++ b/doc/guides/howto/lm_virtio_vhost_user.rst
@@ -415,7 +415,7 @@ setup_dpdk_virtio_in_vm.sh
    /root/dpdk/usertools/dpdk-hugepages.py --setup 2G
    /root/dpdk/usertools/dpdk-hugepages.py --show
 
-   ifconfig -a
+   ip -br link show
    /root/dpdk/usertools/dpdk-devbind.py --status
 
    rmmod virtio-pci
-- 
2.43.0

[PATCH 3/4] doc: replace ifconfig in testpmd doc

[Stephen Hemminger]

The ifconfig command is legacy and no longer maintained;
replace it with equivalent ip command.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 2fbf9220d8..74754216f0 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -1381,7 +1381,8 @@ Set the allmulti mode for a port or for all ports::
 
    testpmd> set allmulti (port_id|all) (on|off)
 
-Same as the ifconfig (8) option. Controls how multicast packets are handled.
+Same as the ``ip link set NETDEV allmulticast (on|off)`` command.
+Controls how multicast packets are handled.
 
 set flow_ctrl rx
 ~~~~~~~~~~~~~~~~
-- 
2.43.0

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

[Stephen Hemminger]

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(-)

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):
 
-- 
2.43.0

Re: [PATCH 0/4] Replace references to ifconfig in doc

[Bruce Richardson]

On Tue, Apr 02, 2024 at 09:29:32AM -0700, Stephen Hemminger wrote:
> Replace references to ifconfig in documentation.
> The ifconfig command is deprecated and has been replaced by
> iproute2 for 20 years.
> 
Nit: replaced on Linux, not on BSD (or replacing ipconfig on windows!).

However, given the majority of the commands referenced here are likely
running on Linux this change does seem reasonable.

/Bruce