Skip to contentSkip to conversation

documentation: networking: fix spelling mistakes

PATCH In review Khaled Elnaggar 5 participants 8 messages Jan 23, 2025 – Jan 27, 2025

Subsystems (5)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 documentation: networking: fix spelling mistakes

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

---
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(-)
Documentation/networking/can.rst +2 -2
index 62519d38c58b..b018ce346392 100644
@@ -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.
 
Documentation/networking/napi.rst +1 -1
index 6083210ab2a4..f970a2be271a 100644
@@ -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

maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 3 lines · Khaled Elnaggar

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

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

Marc

Signature · 4 lines
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   |
Reviewed-by on v1 1/1
#2 lore raw
In reply to Khaled Elnaggar
Quoted 6 lines · Khaled Elnaggar

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

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

Quoted 45 lines

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(-)
Documentation/networking/can.rst +2 -2
index 62519d38c58b..b018ce346392 100644
@@ -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.
 
Documentation/networking/napi.rst +1 -2
index 6083210ab2a4..f970a2be271a 100644
@@ -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

#3 lore raw
Quoted 4 lines · Przemek Kitszel

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

Quoted 2 lines

I'm assuming you have fixed all the typos in that two files, with that:

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

Thanks,
Khaled

#4 lore raw
Quoted 9 lines · Khaled Elnaggar
Quoted 4 lines · Przemek Kitszel

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.

Quoted 12 lines

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

Quoted 2 lines

I'm assuming you have fixed all the typos in that two files, with that:

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

Thanks,
Khaled

#5 lore raw
Quoted 3 lines · Przemek Kitszel

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

reviewer Acked-by on v1 1/1
#6 lore raw
In reply to Khaled Elnaggar
Quoted 3 lines · Khaled Elnaggar

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

Thanks.

Quoted 48 lines

---
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(-)
Documentation/networking/can.rst +2 -2
index 62519d38c58b..b018ce346392 100644
@@ -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.
 
Documentation/networking/napi.rst +1 -2
index 6083210ab2a4..f970a2be271a 100644
@@ -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

Signature · 1 line
~Randy
Reviewed-by on v1 1/1
#7 lore raw
In reply to Khaled Elnaggar
Quoted 22 lines · Khaled Elnaggar
Documentation/networking/can.rst +2 -2
index 62519d38c58b..b018ce346392 100644
@@ -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.
 
Documentation/networking/napi.rst +0 -0
index 6083210ab2a4..f970a2be271a 100644

Documentation/networking/napi.rst It is expected that ``irq-suspend-timeout`` will be set to a value much larger · line 368

Quoted 8 lines
Documentation/networking/napi.rst +1 -1
@@ -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!

Signature · 1 line
An old man doll... just what I always wanted! - Clara