[PATCH iproute2 0/2] Fix some more typos in docs and comments

[PATCH iproute2 0/2] Fix some more typos in docs and comments

[Andrea Claudi]

Time for some start-of-the-year cleanup :)

Using codespell, fix most of the typos in iproute2 docs and comments,
except for some false positives. I didn't bother to report a Fixes tag
for all the typos, but I can do that if needed.

Andrea Claudi (2):
  docs, man: fix some typos
  treewide: fix typos in various comments

 devlink/devlink.c           | 2 +-
 doc/actions/actions-general | 2 +-
 examples/bpf/README         | 2 +-
 include/bpf_api.h           | 2 +-
 include/libiptc/libiptc.h   | 2 +-
 include/xt-internal.h       | 2 +-
 lib/json_print.c            | 2 +-
 man/man8/devlink-rate.8     | 2 +-
 rdma/rdma.h                 | 2 +-
 tc/em_canid.c               | 2 +-
 tc/m_gact.c                 | 2 +-
 tc/q_htb.c                  | 3 ++-
 tc/q_netem.c                | 2 +-
 tipc/README                 | 2 +-
 14 files changed, 15 insertions(+), 14 deletions(-)

-- 
2.43.0

[PATCH iproute2 1/2] docs, man: fix some typos

[Andrea Claudi]

Fix some typos and spelling errors in iproute2 documentation.

Signed-off-by: Andrea Claudi <aclaudi@redhat.com>
---
 doc/actions/actions-general | 2 +-
 examples/bpf/README         | 2 +-
 man/man8/devlink-rate.8     | 2 +-
 tipc/README                 | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/actions/actions-general b/doc/actions/actions-general
index a0074a58..41c74d38 100644
--- a/doc/actions/actions-general
+++ b/doc/actions/actions-general
@@ -116,7 +116,7 @@ The script below does the following:
 - If it does exceed its rate, its "color" changes to a mark of 2 and it is
 then passed through a second meter.
 
--The second meter is shared across all flows on that device [i am surpised
+-The second meter is shared across all flows on that device [i am surprised
 that this seems to be not a well know feature of the policer; Bert was telling
 me that someone was writing a qdisc just to do sharing across multiple devices;
 it must be the summer heat again; weve had someone doing that every year around
diff --git a/examples/bpf/README b/examples/bpf/README
index b7261191..4c27bb4e 100644
--- a/examples/bpf/README
+++ b/examples/bpf/README
@@ -15,4 +15,4 @@ with syntax and features:
 
 Note: Users should use new BTF way to defined the maps, the examples
 in legacy folder which is using struct bpf_elf_map defined maps is not
-recommanded.
+recommended.
diff --git a/man/man8/devlink-rate.8 b/man/man8/devlink-rate.8
index bcec3c31..f09ac4ac 100644
--- a/man/man8/devlink-rate.8
+++ b/man/man8/devlink-rate.8
@@ -149,7 +149,7 @@ These parameter accept integer meaning weight or priority of a node.
 - set rate object parent to existing node with name \fINODE_NAME\fR or unset
 parent. Rate limits of the parent node applied to all it's children. Actual
 behaviour is details of driver's implementation. Setting parent to empty ("")
-name due to the kernel logic threated as parent unset.
+name due to the kernel logic treated as parent unset.
 
 .SS devlink port function rate add - create node rate object with specified parameters.
 Creates rate object of type node and sets parameters. Parameters same as for the
diff --git a/tipc/README b/tipc/README
index 578a0b7b..fbeb4345 100644
--- a/tipc/README
+++ b/tipc/README
@@ -16,7 +16,7 @@ bare words specially.
 Help texts are not dynamically generated. That is, we do not pass datastructures
 like command list or option lists and print them dynamically. This is
 intentional. There is always that exception and when it comes to help texts
-these exceptions are normally neglected at the expence of usability.
+these exceptions are normally neglected at the expense of usability.
 
 KEY-VALUE
 ~~~~~~~~~
-- 
2.43.0

[PATCH iproute2 2/2] treewide: fix typos in various comments

[Andrea Claudi]

Fix various typos and spelling errors in some iproute2 comments.

Signed-off-by: Andrea Claudi <aclaudi@redhat.com>
---
 devlink/devlink.c         | 2 +-
 include/bpf_api.h         | 2 +-
 include/libiptc/libiptc.h | 2 +-
 include/xt-internal.h     | 2 +-
 lib/json_print.c          | 2 +-
 rdma/rdma.h               | 2 +-
 tc/em_canid.c             | 2 +-
 tc/m_gact.c               | 2 +-
 tc/q_htb.c                | 3 ++-
 tc/q_netem.c              | 2 +-
 10 files changed, 11 insertions(+), 10 deletions(-)

diff --git a/devlink/devlink.c b/devlink/devlink.c
index 3baad355..8c2e3395 100644
--- a/devlink/devlink.c
+++ b/devlink/devlink.c
@@ -2326,7 +2326,7 @@ static int dl_argv_dry_parse(struct dl *dl, uint64_t o_required,
 	return err;
 }
 
-/* List of extented handles with two slashes. */
+/* List of extended handles with two slashes. */
 static const uint64_t dl_opt_extended_handle[] = {
 	DL_OPT_HANDLEP,
 	DL_OPT_HANDLE_REGION,
diff --git a/include/bpf_api.h b/include/bpf_api.h
index 5887d3a8..287f96b6 100644
--- a/include/bpf_api.h
+++ b/include/bpf_api.h
@@ -253,7 +253,7 @@ static int BPF_FUNC(skb_set_tunnel_opt, struct __sk_buff *skb,
 # define memmove(d, s, n)	__builtin_memmove((d), (s), (n))
 #endif
 
-/* FIXME: __builtin_memcmp() is not yet fully useable unless llvm bug
+/* FIXME: __builtin_memcmp() is not yet fully usable unless llvm bug
  * https://llvm.org/bugs/show_bug.cgi?id=26218 gets resolved. Also
  * this one would generate a reloc entry (non-map), otherwise.
  */
diff --git a/include/libiptc/libiptc.h b/include/libiptc/libiptc.h
index 1bfe4e18..89dce2f9 100644
--- a/include/libiptc/libiptc.h
+++ b/include/libiptc/libiptc.h
@@ -80,7 +80,7 @@ int iptc_append_entry(const xt_chainlabel chain,
 		      const struct ipt_entry *e,
 		      struct xtc_handle *handle);
 
-/* Check whether a mathching rule exists */
+/* Check whether a matching rule exists */
 int iptc_check_entry(const xt_chainlabel chain,
 		      const struct ipt_entry *origfw,
 		      unsigned char *matchmask,
diff --git a/include/xt-internal.h b/include/xt-internal.h
index 89c73e4f..07216140 100644
--- a/include/xt-internal.h
+++ b/include/xt-internal.h
@@ -6,7 +6,7 @@
 #	define XT_LIB_DIR "/lib/xtables"
 #endif
 
-/* protocol family dependent informations */
+/* protocol family dependent information */
 struct afinfo {
 	/* protocol family */
 	int family;
diff --git a/lib/json_print.c b/lib/json_print.c
index 7b3b6c3f..810d496e 100644
--- a/lib/json_print.c
+++ b/lib/json_print.c
@@ -217,7 +217,7 @@ int print_color_bool(enum output_type type,
 
 /* In JSON mode, acts like print_color_bool.
  * Otherwise, will print key with prefix of "no" if false.
- * The show flag is used to suppres printing in non-JSON mode
+ * The show flag is used to suppress printing in non-JSON mode
  */
 int print_color_bool_opt(enum output_type type,
 			 enum color_attr color,
diff --git a/rdma/rdma.h b/rdma/rdma.h
index 1f8f8326..df1852db 100644
--- a/rdma/rdma.h
+++ b/rdma/rdma.h
@@ -40,7 +40,7 @@ struct filter_entry {
 	char *key;
 	char *value;
 	/*
-	 * This field means that we can try to issue .doit calback
+	 * This field means that we can try to issue .doit callback
 	 * on value above. This value can be converted to integer
 	 * with simple atoi(). Otherwise "is_doit" will be false.
 	 */
diff --git a/tc/em_canid.c b/tc/em_canid.c
index 6d06b66a..22854752 100644
--- a/tc/em_canid.c
+++ b/tc/em_canid.c
@@ -26,7 +26,7 @@
 #include <inttypes.h>
 #include "m_ematch.h"
 
-#define EM_CANID_RULES_MAX 400 /* Main reason for this number is Nelink
+#define EM_CANID_RULES_MAX 400 /* Main reason for this number is Netlink
 	message size limit equal to Single memory page size. When dump()
 	is invoked, there are even some ematch related headers sent from
 	kernel to userspace together with em_canid configuration --
diff --git a/tc/m_gact.c b/tc/m_gact.c
index e294a701..225ffce4 100644
--- a/tc/m_gact.c
+++ b/tc/m_gact.c
@@ -18,7 +18,7 @@
 #include "tc_util.h"
 #include <linux/tc_act/tc_gact.h>
 
-/* define to turn on probablity stuff */
+/* define to turn on probability stuff */
 
 #ifdef CONFIG_GACT_PROB
 static const char *prob_n2a(int p)
diff --git a/tc/q_htb.c b/tc/q_htb.c
index 63b9521b..351ef693 100644
--- a/tc/q_htb.c
+++ b/tc/q_htb.c
@@ -224,7 +224,8 @@ static int htb_parse_class_opt(struct qdisc_util *qu, int argc, char **argv,
 	opt.ceil.rate = (ceil64 >= (1ULL << 32)) ? ~0U : ceil64;
 
 	/* compute minimal allowed burst from rate; mtu is added here to make
-	   sute that buffer is larger than mtu and to have some safeguard space */
+	   sure that buffer is larger than mtu and to have some safeguard space
+	 */
 	if (!buffer)
 		buffer = rate64 / get_hz() + mtu;
 	if (!cbuffer)
diff --git a/tc/q_netem.c b/tc/q_netem.c
index 5d5aad80..4ce9ab6e 100644
--- a/tc/q_netem.c
+++ b/tc/q_netem.c
@@ -117,7 +117,7 @@ static void print_corr(bool present, __u32 value)
 }
 
 /*
- * Simplistic file parser for distrbution data.
+ * Simplistic file parser for distribution data.
  * Format is:
  *	# comment line(s)
  *	data0 data1 ...
-- 
2.43.0

Re: [PATCH iproute2 1/2] docs, man: fix some typos

[Petr Machata]

Andrea Claudi <aclaudi@redhat.com> writes:

> Fix some typos and spelling errors in iproute2 documentation.
>
> Signed-off-by: Andrea Claudi <aclaudi@redhat.com>

Reviewed-by: Petr Machata <petrm@nvidia.com>

> --- a/doc/actions/actions-general
> +++ b/doc/actions/actions-general
> @@ -116,7 +116,7 @@ The script below does the following:
>  - If it does exceed its rate, its "color" changes to a mark of 2 and it is
>  then passed through a second meter.
>  
> --The second meter is shared across all flows on that device [i am surpised
> +-The second meter is shared across all flows on that device [i am surprised
>  that this seems to be not a well know feature of the policer; Bert was telling
>  me that someone was writing a qdisc just to do sharing across multiple devices;
>  it must be the summer heat again; weve had someone doing that every year around

This document reads more like a newsgroup article or something from a
zine than a formal piece of documentation. Even in this excerpt we see
an uncapitalized "i" and a "weve", and there are many issues like this
elsewhere. Fixing it feels a bit futile, plus I kinda like the
slice-of-history nature of the document :) But yeah, the fix is correct.

Re: [PATCH iproute2 2/2] treewide: fix typos in various comments

[Petr Machata]

Andrea Claudi <aclaudi@redhat.com> writes:

> Fix various typos and spelling errors in some iproute2 comments.
>
> Signed-off-by: Andrea Claudi <aclaudi@redhat.com>

Reviewed-by: Petr Machata <petrm@nvidia.com>

> diff --git a/include/bpf_api.h b/include/bpf_api.h
> index 5887d3a8..287f96b6 100644
> --- a/include/bpf_api.h
> +++ b/include/bpf_api.h
> @@ -253,7 +253,7 @@ static int BPF_FUNC(skb_set_tunnel_opt, struct __sk_buff *skb,
>  # define memmove(d, s, n)	__builtin_memmove((d), (s), (n))
>  #endif
>  
> -/* FIXME: __builtin_memcmp() is not yet fully useable unless llvm bug
> +/* FIXME: __builtin_memcmp() is not yet fully usable unless llvm bug
>   * https://llvm.org/bugs/show_bug.cgi?id=26218 gets resolved. Also
>   * this one would generate a reloc entry (non-map), otherwise.
>   */

BTW, I wouldn't spell it "useable" myself, but I think it is not
incorrect.

Re: [PATCH iproute2 1/2] docs, man: fix some typos

[Stephen Hemminger]

On Tue,  9 Jan 2024 17:32:34 +0100
Andrea Claudi <aclaudi@redhat.com> wrote:

> Fix some typos and spelling errors in iproute2 documentation.
> 
> Signed-off-by: Andrea Claudi <aclaudi@redhat.com>
> ---
>  doc/actions/actions-general | 2 +-
>  examples/bpf/README         | 2 +-
>  man/man8/devlink-rate.8     | 2 +-
>  tipc/README                 | 2 +-
>  4 files changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/doc/actions/actions-general b/doc/actions/actions-general
> index a0074a58..41c74d38 100644
> --- a/doc/actions/actions-general
> +++ b/doc/actions/actions-general

I am thinking about removing all the stuff in doc/actions.
It is in rough shape and doesn't really provide more info than is
available elsewhere. My preference is to have information in only
one place the man pages.

Re: [PATCH iproute2 1/2] docs, man: fix some typos

[Stephen Hemminger]

On Tue,  9 Jan 2024 17:32:34 +0100
Andrea Claudi <aclaudi@redhat.com> wrote:

> diff --git a/doc/actions/actions-general b/doc/actions/actions-general
> index a0074a58..41c74d38 100644
> --- a/doc/actions/actions-general
> +++ b/doc/actions/actions-general
> @@ -116,7 +116,7 @@ The script below does the following:
>  - If it does exceed its rate, its "color" changes to a mark of 2 and it is
>  then passed through a second meter.
>  
> --The second meter is shared across all flows on that device [i am surpised
> +-The second meter is shared across all flows on that device [i am surprised
>  that this seems to be not a well know feature of the policer; Bert was telling
>  me that someone was writing a qdisc just to do sharing across multiple devices;
>  it must be the summer heat again; weve had someone doing that every year around

Don't bother fixing this file, it will be dropped in next release.

Re: [PATCH iproute2 2/2] treewide: fix typos in various comments

[Stephen Hemminger]

On Tue,  9 Jan 2024 17:32:35 +0100
Andrea Claudi <aclaudi@redhat.com> wrote:

> diff --git a/include/libiptc/libiptc.h b/include/libiptc/libiptc.h
> index 1bfe4e18..89dce2f9 100644
> --- a/include/libiptc/libiptc.h
> +++ b/include/libiptc/libiptc.h
> @@ -80,7 +80,7 @@ int iptc_append_entry(const xt_chainlabel chain,
>  		      const struct ipt_entry *e,
>  		      struct xtc_handle *handle);
>  
> -/* Check whether a mathching rule exists */
> +/* Check whether a matching rule exists */
>  int iptc_check_entry(const xt_chainlabel chain,
>  		      const struct ipt_entry *origfw,
>  		      unsigned char *matchmask,

This is no longer in current code tree.
Please rebase and resubmit

Re: [PATCH iproute2 2/2] treewide: fix typos in various comments

[Andrea Claudi]

On Thu, Jan 11, 2024 at 11:40:35AM -0800, Stephen Hemminger wrote:
> On Tue,  9 Jan 2024 17:32:35 +0100
> Andrea Claudi <aclaudi@redhat.com> wrote:
> 
> > diff --git a/include/libiptc/libiptc.h b/include/libiptc/libiptc.h
> > index 1bfe4e18..89dce2f9 100644
> > --- a/include/libiptc/libiptc.h
> > +++ b/include/libiptc/libiptc.h
> > @@ -80,7 +80,7 @@ int iptc_append_entry(const xt_chainlabel chain,
> >  		      const struct ipt_entry *e,
> >  		      struct xtc_handle *handle);
> >  
> > -/* Check whether a mathching rule exists */
> > +/* Check whether a matching rule exists */
> >  int iptc_check_entry(const xt_chainlabel chain,
> >  		      const struct ipt_entry *origfw,
> >  		      unsigned char *matchmask,
> 
> This is no longer in current code tree.
> Please rebase and resubmit

Woops, sorry. Will do.