[PATCH 1/2] docs: net: Fix text in eth/intel, mlx5 and switchdev docs

[PATCH 1/2] docs: net: Fix text in eth/intel, mlx5 and switchdev docs

[Abhinav Saxena]

Fix various issues across networking documentation: remove duplicate word
in drivers/ethernet/intel/iavf, fix quote formatting in mlx5/counters,
correct typo in rds.rst and improve wording in switchdev topology doc.
These changes are purely documentation cleanup.

Signed-off-by: Abhinav Saxena <xandfury@gmail.com>
---
 Documentation/networking/device_drivers/ethernet/intel/iavf.rst | 2 +-
 .../device_drivers/ethernet/mellanox/mlx5/counters.rst          | 2 +-
 Documentation/networking/rds.rst                                | 2 +-
 Documentation/networking/switchdev.rst                          | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/networking/device_drivers/ethernet/intel/iavf.rst b/Documentation/networking/device_drivers/ethernet/intel/iavf.rst
index eb926c3bd4cd..73ce04c05071 100644
--- a/Documentation/networking/device_drivers/ethernet/intel/iavf.rst
+++ b/Documentation/networking/device_drivers/ethernet/intel/iavf.rst
@@ -171,7 +171,7 @@ queues: for each tc, <num queues>@<offset> (e.g. queues 16@0 16@16 assigns
 16 queues to tc0 at offset 0 and 16 queues to tc1 at offset 16. Max total
 number of queues for all tcs is 64 or number of cores, whichever is lower.)
 
-hw 1 mode channel: ‘channel’ with ‘hw’ set to 1 is a new new hardware
+hw 1 mode channel: 'channel' with 'hw' set to 1 is a new hardware
 offload mode in mqprio that makes full use of the mqprio options, the
 TCs, the queue configurations, and the QoS parameters.
 
diff --git a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/counters.rst b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/counters.rst
index 99d95be4d159..b23f36a2d28c 100644
--- a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/counters.rst
+++ b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/counters.rst
@@ -1135,7 +1135,7 @@ like flow control, FEC and more.
      - Informative
 
    * - `rx_pcs_symbol_err_phy`
-     - This counter counts the number of symbol errors that wasn’t corrected by
+     - This counter counts the number of symbol errors that wasn't corrected by
        FEC correction algorithm or that FEC algorithm was not active on this
        interface. If this counter is increasing, it implies that the link
        between the NIC and the network is suffering from high BER, and that
diff --git a/Documentation/networking/rds.rst b/Documentation/networking/rds.rst
index 498395f5fbcb..955afe0567aa 100644
--- a/Documentation/networking/rds.rst
+++ b/Documentation/networking/rds.rst
@@ -339,7 +339,7 @@ The send path
   rds_sendmsg()
     - struct rds_message built from incoming data
     - CMSGs parsed (e.g. RDMA ops)
-    - transport connection alloced and connected if not already
+    - transport connection allocated and connected if not already
     - rds_message placed on send queue
     - send worker awoken
 
diff --git a/Documentation/networking/switchdev.rst b/Documentation/networking/switchdev.rst
index f355f0166f1b..df4b4c4a15d5 100644
--- a/Documentation/networking/switchdev.rst
+++ b/Documentation/networking/switchdev.rst
@@ -162,7 +162,7 @@ The switchdev driver can know a particular port's position in the topology by
 monitoring NETDEV_CHANGEUPPER notifications.  For example, a port moved into a
 bond will see its upper master change.  If that bond is moved into a bridge,
 the bond's upper master will change.  And so on.  The driver will track such
-movements to know what position a port is in in the overall topology by
+movements to know what position a port is in the overall topology by
 registering for netdevice events and acting on NETDEV_CHANGEUPPER.
 
 L2 Forwarding Offload
-- 
2.34.1

[PATCH 2/2] docs: net: Fix sfp-phylink whitespace

[Abhinav Saxena]

Remove trailing whitespace from sfp-phylink.rst documentation. Trailing
whitespace can cause diff formatting issues and violate kernel coding style
guidelines. This is a trivial cleanup with no content changes.

Signed-off-by: Abhinav Saxena <xandfury@gmail.com>
---
 Documentation/networking/sfp-phylink.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/networking/sfp-phylink.rst b/Documentation/networking/sfp-phylink.rst
index 5bf285d73e8a..4ce46aef6568 100644
--- a/Documentation/networking/sfp-phylink.rst
+++ b/Documentation/networking/sfp-phylink.rst
@@ -142,7 +142,7 @@ this documentation.
 						  const struct ethtool_link_ksettings *cmd)
 	{
 		struct foo_priv *priv = netdev_priv(dev);
-	
+
 		return phylink_ethtool_ksettings_set(priv->phylink, cmd);
 	}
 
@@ -150,7 +150,7 @@ this documentation.
 						  struct ethtool_link_ksettings *cmd)
 	{
 		struct foo_priv *priv = netdev_priv(dev);
-	
+
 		return phylink_ethtool_ksettings_get(priv->phylink, cmd);
 	}
 
-- 
2.34.1

Re: [PATCH 1/2] docs: net: Fix text in eth/intel, mlx5 and switchdev docs

[Jakub Kicinski]

On Fri,  8 Nov 2024 13:25:47 -0700 Abhinav Saxena wrote:
> diff --git a/Documentation/networking/switchdev.rst b/Documentation/networking/switchdev.rst
> index f355f0166f1b..df4b4c4a15d5 100644
> --- a/Documentation/networking/switchdev.rst
> +++ b/Documentation/networking/switchdev.rst
> @@ -162,7 +162,7 @@ The switchdev driver can know a particular port's position in the topology by
>  monitoring NETDEV_CHANGEUPPER notifications.  For example, a port moved into a
>  bond will see its upper master change.  If that bond is moved into a bridge,
>  the bond's upper master will change.  And so on.  The driver will track such
> -movements to know what position a port is in in the overall topology by
> +movements to know what position a port is in the overall topology by

Are you sure? The first 'in' is for position, the second for topology.
Equivalent to:

 movements to know in what position a port is in the overall topology by
                   ^^                         ^^

We can rephrase to avoid the double in:

  The driver will track such movements to know the position of a port
  within the overall topology by registering for netdevice events and
  acting on NETDEV_CHANGEUPPER.

>  registering for netdevice events and acting on NETDEV_CHANGEUPPER.
-- 
pw-bot: cr