| Message ID | cda844f5f7fe512ca9b7f87a6545157394b9d9ae.1704816744.git.aclaudi@redhat.com (mailing list archive) |
|---|---|
| State | Changes Requested |
| Delegated to: | Stephen Hemminger |
| Headers | show |
| Series | Fix some more typos in docs and comments | expand |
| Context | Check | Description |
|---|---|---|
| netdev/tree_selection | success | Not a local patch |
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.
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.
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.
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 ~~~~~~~~~
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(-)