[PATCH] documentation: networking: fix spelling mistakes

[PATCH] documentation: networking: fix spelling mistakes

[Khaled Elnaggar]

Fix a couple of typos/spelling mistakes in the documentation.

Signed-off-by: Khaled Elnaggar <khaledelnaggarlinux@gmail.com>
---
Hello, I hope the patch is self-explanatory. Please let me know if you
have any comments.

Aside: CCing Shuah and linux-kernel-mentees as I am working on the mentorship
application tasks.

Thanks
Khaled
---
 Documentation/networking/can.rst  | 4 ++--
 Documentation/networking/napi.rst | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/networking/can.rst b/Documentation/networking/can.rst
index 62519d38c58b..b018ce346392 100644
--- a/Documentation/networking/can.rst
+++ b/Documentation/networking/can.rst
@@ -699,10 +699,10 @@ RAW socket option CAN_RAW_JOIN_FILTERS

 The CAN_RAW socket can set multiple CAN identifier specific filters that
 lead to multiple filters in the af_can.c filter processing. These filters
-are indenpendent from each other which leads to logical OR'ed filters when
+are independent from each other which leads to logical OR'ed filters when
 applied (see :ref:`socketcan-rawfilter`).

-This socket option joines the given CAN filters in the way that only CAN
+This socket option joins the given CAN filters in the way that only CAN
 frames are passed to user space that matched *all* given CAN filters. The
 semantic for the applied filters is therefore changed to a logical AND.

diff --git a/Documentation/networking/napi.rst b/Documentation/networking/napi.rst
index 6083210ab2a4..f970a2be271a 100644
--- a/Documentation/networking/napi.rst
+++ b/Documentation/networking/napi.rst
@@ -362,7 +362,7 @@ It is expected that ``irq-suspend-timeout`` will be set to a value much larger
 than ``gro_flush_timeout`` as ``irq-suspend-timeout`` should suspend IRQs for
 the duration of one userland processing cycle.

-While it is not stricly necessary to use ``napi_defer_hard_irqs`` and
+While it is not strictly necessary to use ``napi_defer_hard_irqs`` and
 ``gro_flush_timeout`` to use IRQ suspension, their use is strongly
 recommended.

--
2.45.2

Re: [PATCH] documentation: networking: fix spelling mistakes

[Marc Kleine-Budde]

[-- Attachment #1: Type: text/plain, Size: 558 bytes --]

On 23.01.2025 10:25:20, Khaled Elnaggar wrote:
> Fix a couple of typos/spelling mistakes in the documentation.
> 
> Signed-off-by: Khaled Elnaggar <khaledelnaggarlinux@gmail.com>
Acked-by: Marc Kleine-Budde <mkl@pengutronix.de>

Feel free to take the patch via the net-tree.

Marc

-- 
Pengutronix e.K.                 | Marc Kleine-Budde          |
Embedded Linux                   | https://www.pengutronix.de |
Vertretung Nürnberg              | Phone: +49-5121-206917-129 |
Amtsgericht Hildesheim, HRA 2686 | Fax:   +49-5121-206917-9   |

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: [PATCH] documentation: networking: fix spelling mistakes

[Przemek Kitszel]

On 1/23/25 09:25, Khaled Elnaggar wrote:
> Fix a couple of typos/spelling mistakes in the documentation.
> 
> Signed-off-by: Khaled Elnaggar <khaledelnaggarlinux@gmail.com>
> ---
> Hello, I hope the patch is self-explanatory. Please let me know if you
> have any comments.

looks good, also process wise, also this comment is properly put

(one thing to possibly improve would be to put "net" as the target in
the subject (see other patches on the netdev mailing list); for
non-fixes it would be "net-next"; but don't resubmit just for that)

I'm assuming you have fixed all the typos in that two files, with that:
Reviewed-by: Przemek Kitszel <przemyslaw.kitszel@intel.com>

> 
> Aside: CCing Shuah and linux-kernel-mentees as I am working on the mentorship
> application tasks.
> 
> Thanks
> Khaled
> ---
>   Documentation/networking/can.rst  | 4 ++--
>   Documentation/networking/napi.rst | 2 +-
>   2 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/networking/can.rst b/Documentation/networking/can.rst
> index 62519d38c58b..b018ce346392 100644
> --- a/Documentation/networking/can.rst
> +++ b/Documentation/networking/can.rst
> @@ -699,10 +699,10 @@ RAW socket option CAN_RAW_JOIN_FILTERS
> 
>   The CAN_RAW socket can set multiple CAN identifier specific filters that
>   lead to multiple filters in the af_can.c filter processing. These filters
> -are indenpendent from each other which leads to logical OR'ed filters when
> +are independent from each other which leads to logical OR'ed filters when
>   applied (see :ref:`socketcan-rawfilter`).
> 
> -This socket option joines the given CAN filters in the way that only CAN
> +This socket option joins the given CAN filters in the way that only CAN
>   frames are passed to user space that matched *all* given CAN filters. The
>   semantic for the applied filters is therefore changed to a logical AND.
> 
> diff --git a/Documentation/networking/napi.rst b/Documentation/networking/napi.rst
> index 6083210ab2a4..f970a2be271a 100644
> --- a/Documentation/networking/napi.rst
> +++ b/Documentation/networking/napi.rst
> @@ -362,7 +362,7 @@ It is expected that ``irq-suspend-timeout`` will be set to a value much larger
>   than ``gro_flush_timeout`` as ``irq-suspend-timeout`` should suspend IRQs for
>   the duration of one userland processing cycle.
> 
> -While it is not stricly necessary to use ``napi_defer_hard_irqs`` and
> +While it is not strictly necessary to use ``napi_defer_hard_irqs`` and
>   ``gro_flush_timeout`` to use IRQ suspension, their use is strongly
>   recommended.
> 
> --
> 2.45.2
> 
> 

Re: [PATCH] documentation: networking: fix spelling mistakes

[Randy Dunlap]

On 1/23/25 12:25 AM, Khaled Elnaggar wrote:
> Fix a couple of typos/spelling mistakes in the documentation.
> 
> Signed-off-by: Khaled Elnaggar <khaledelnaggarlinux@gmail.com>


Acked-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
> Hello, I hope the patch is self-explanatory. Please let me know if you
> have any comments.
> 
> Aside: CCing Shuah and linux-kernel-mentees as I am working on the mentorship
> application tasks.
> 
> Thanks
> Khaled
> ---
>  Documentation/networking/can.rst  | 4 ++--
>  Documentation/networking/napi.rst | 2 +-
>  2 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/networking/can.rst b/Documentation/networking/can.rst
> index 62519d38c58b..b018ce346392 100644
> --- a/Documentation/networking/can.rst
> +++ b/Documentation/networking/can.rst
> @@ -699,10 +699,10 @@ RAW socket option CAN_RAW_JOIN_FILTERS
> 
>  The CAN_RAW socket can set multiple CAN identifier specific filters that
>  lead to multiple filters in the af_can.c filter processing. These filters
> -are indenpendent from each other which leads to logical OR'ed filters when
> +are independent from each other which leads to logical OR'ed filters when
>  applied (see :ref:`socketcan-rawfilter`).
> 
> -This socket option joines the given CAN filters in the way that only CAN
> +This socket option joins the given CAN filters in the way that only CAN
>  frames are passed to user space that matched *all* given CAN filters. The
>  semantic for the applied filters is therefore changed to a logical AND.
> 
> diff --git a/Documentation/networking/napi.rst b/Documentation/networking/napi.rst
> index 6083210ab2a4..f970a2be271a 100644
> --- a/Documentation/networking/napi.rst
> +++ b/Documentation/networking/napi.rst
> @@ -362,7 +362,7 @@ It is expected that ``irq-suspend-timeout`` will be set to a value much larger
>  than ``gro_flush_timeout`` as ``irq-suspend-timeout`` should suspend IRQs for
>  the duration of one userland processing cycle.
> 
> -While it is not stricly necessary to use ``napi_defer_hard_irqs`` and
> +While it is not strictly necessary to use ``napi_defer_hard_irqs`` and
>  ``gro_flush_timeout`` to use IRQ suspension, their use is strongly
>  recommended.
> 
> --
> 2.45.2
> 
> 

-- 
~Randy

Re: [PATCH] documentation: networking: fix spelling mistakes

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 1849 bytes --]

On Thu, Jan 23, 2025 at 10:25:20AM +0200, Khaled Elnaggar wrote:
> diff --git a/Documentation/networking/can.rst b/Documentation/networking/can.rst
> index 62519d38c58b..b018ce346392 100644
> --- a/Documentation/networking/can.rst
> +++ b/Documentation/networking/can.rst
> @@ -699,10 +699,10 @@ RAW socket option CAN_RAW_JOIN_FILTERS
> 
>  The CAN_RAW socket can set multiple CAN identifier specific filters that
>  lead to multiple filters in the af_can.c filter processing. These filters
> -are indenpendent from each other which leads to logical OR'ed filters when
> +are independent from each other which leads to logical OR'ed filters when
>  applied (see :ref:`socketcan-rawfilter`).
> 
> -This socket option joines the given CAN filters in the way that only CAN
> +This socket option joins the given CAN filters in the way that only CAN
>  frames are passed to user space that matched *all* given CAN filters. The
>  semantic for the applied filters is therefore changed to a logical AND.
> 
> diff --git a/Documentation/networking/napi.rst b/Documentation/networking/napi.rst
> index 6083210ab2a4..f970a2be271a 100644
> --- a/Documentation/networking/napi.rst
> +++ b/Documentation/networking/napi.rst
> @@ -362,7 +362,7 @@ It is expected that ``irq-suspend-timeout`` will be set to a value much larger
>  than ``gro_flush_timeout`` as ``irq-suspend-timeout`` should suspend IRQs for
>  the duration of one userland processing cycle.
> 
> -While it is not stricly necessary to use ``napi_defer_hard_irqs`` and
> +While it is not strictly necessary to use ``napi_defer_hard_irqs`` and
>  ``gro_flush_timeout`` to use IRQ suspension, their use is strongly
>  recommended.
> 

Looks OK, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH] documentation: networking: fix spelling mistakes

[Khaled Elnaggar]

On 1/23/25 11:12 AM, Przemek Kitszel wrote:

> looks good, also process wise, also this comment is properly put
> (one thing to possibly improve would be to put "net" as the target in
> the subject (see other patches on the netdev mailing list); for
> non-fixes it would be "net-next"; but don't resubmit just for that)

Ahaa, I also should not have sent this patch during a merge
window where net-next is closed?

Thank you for the heads up, I will be spending more time with
https://docs.kernel.org/process/maintainer-netdev.html

> I'm assuming you have fixed all the typos in that two files, with that:
> Reviewed-by: Przemek Kitszel <przemyslaw.kitszel@intel.com>

Yes that was all I could find in these two files.

Thanks,
Khaled

Re: [PATCH] documentation: networking: fix spelling mistakes

[Przemek Kitszel]

On 1/25/25 13:11, Khaled Elnaggar wrote:
> On 1/23/25 11:12 AM, Przemek Kitszel wrote:
> 
>> looks good, also process wise, also this comment is properly put
>> (one thing to possibly improve would be to put "net" as the target in
>> the subject (see other patches on the netdev mailing list); for
>> non-fixes it would be "net-next"; but don't resubmit just for that)
> 
> Ahaa, I also should not have sent this patch during a merge
> window where net-next is closed?

this patch is fine for -net, as this is fixing the bugs in the text,
those are rather special, as there is no risk of regression :)
I'm not sure if Fixes tag is necessary for spelling fixes though.

> 
> Thank you for the heads up, I will be spending more time with
> https://docs.kernel.org/process/maintainer-netdev.html
> 
>> I'm assuming you have fixed all the typos in that two files, with that:
>> Reviewed-by: Przemek Kitszel <przemyslaw.kitszel@intel.com>
> 
> Yes that was all I could find in these two files.
> 
> Thanks,
> Khaled
> 

Re: [PATCH] documentation: networking: fix spelling mistakes

[Khaled Elnaggar]

On 1/27/25 10:16 AM, Przemek Kitszel wrote:

> this patch is fine for -net, as this is fixing the bugs in the text,
> those are rather special, as there is no risk of regression :)
> I'm not sure if Fixes tag is necessary for spelling fixes though.

Makes sense. Thanks.
Khaled

[PATCH] documentation : networking : Fix spelling mistakes

[Chandra Mohan Sundar]

Fix few spelling mistakes in networking documentation.

Signed-off-by: Chandra Mohan Sundar <chandru.dav@gmail.com>
---
 .../ethernet/freescale/dpaa2/switch-driver.rst              | 2 +-
 .../device_drivers/ethernet/marvell/octeontx2.rst           | 2 +-
 Documentation/networking/devlink/devlink-trap.rst           | 2 +-
 Documentation/networking/phy.rst                            | 6 +++---
 4 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/networking/device_drivers/ethernet/freescale/dpaa2/switch-driver.rst b/Documentation/networking/device_drivers/ethernet/freescale/dpaa2/switch-driver.rst
index 8bf411b857d4..5f3885e56f58 100644
--- a/Documentation/networking/device_drivers/ethernet/freescale/dpaa2/switch-driver.rst
+++ b/Documentation/networking/device_drivers/ethernet/freescale/dpaa2/switch-driver.rst
@@ -70,7 +70,7 @@ the DPSW object that it will probe:
 Besides the configuration of the actual DPSW object, the dpaa2-switch driver
 will need the following DPAA2 objects:
 
- * 1 DPMCP - A Management Command Portal object is needed for any interraction
+ * 1 DPMCP - A Management Command Portal object is needed for any interaction
    with the MC firmware.
 
  * 1 DPBP - A Buffer Pool is used for seeding buffers intended for the Rx path
diff --git a/Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst b/Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst
index af7db0e91f6b..a52850602cd8 100644
--- a/Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst
+++ b/Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst
@@ -66,7 +66,7 @@ Admin Function driver
 As mentioned above RVU PF0 is called the admin function (AF), this driver
 supports resource provisioning and configuration of functional blocks.
 Doesn't handle any I/O. It sets up few basic stuff but most of the
-funcionality is achieved via configuration requests from PFs and VFs.
+functionality is achieved via configuration requests from PFs and VFs.
 
 PF/VFs communicates with AF via a shared memory region (mailbox). Upon
 receiving requests AF does resource provisioning and other HW configuration.
diff --git a/Documentation/networking/devlink/devlink-trap.rst b/Documentation/networking/devlink/devlink-trap.rst
index 2c14dfe69b3a..5885e21e2212 100644
--- a/Documentation/networking/devlink/devlink-trap.rst
+++ b/Documentation/networking/devlink/devlink-trap.rst
@@ -451,7 +451,7 @@ be added to the following table:
    * - ``udp_parsing``
      - ``drop``
      - Traps packets dropped due to an error in the UDP header parsing.
-       This packet trap could include checksum errorrs, an improper UDP
+       This packet trap could include checksum errors, an improper UDP
        length detected (smaller than 8 bytes) or detection of header
        truncation.
    * - ``tcp_parsing``
diff --git a/Documentation/networking/phy.rst b/Documentation/networking/phy.rst
index f64641417c54..241292b12032 100644
--- a/Documentation/networking/phy.rst
+++ b/Documentation/networking/phy.rst
@@ -19,8 +19,8 @@ amounts of redundant code.  Also, on embedded systems with multiple (and
 sometimes quite different) ethernet controllers connected to the same
 management bus, it is difficult to ensure safe use of the bus.
 
-Since the PHYs are devices, and the management busses through which they are
-accessed are, in fact, busses, the PHY Abstraction Layer treats them as such.
+Since the PHYs are devices, and the management buses through which they are
+accessed are, in fact, buses, the PHY Abstraction Layer treats them as such.
 In doing so, it has these goals:
 
 #. Increase code-reuse
@@ -35,7 +35,7 @@ The MDIO bus
 ============
 
 Most network devices are connected to a PHY by means of a management bus.
-Different devices use different busses (though some share common interfaces).
+Different devices use different buses (though some share common interfaces).
 In order to take advantage of the PAL, each bus interface needs to be
 registered as a distinct device.
 
-- 
2.43.0