Re: [PATCH v3] Remove duplicated words across the whole documentation

From: Jules Maselbas
Date: Fri Aug 26 2022 - 12:51:54 EST


On Fri, Aug 26, 2022 at 04:40:50PM +0000, Conor.Dooley@xxxxxxxxxxxxx wrote:
> Hey Jules,
> On 26/08/2022 17:34, Jules Maselbas wrote:
> > Remove duplicated words (the, at, be ...) across the whole documentation.
> > In some cases the duplicated words are replaced by something that makes
> > more sense, for instance: "be be" is replaced by "can be" when possible.
> >
> > There are likely more duplicated words to be found.
> >
> > CC: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> > CC: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
> > CC: Jonathan Corbet <corbet@xxxxxxx>
> > CC: linux-doc@xxxxxxxxxxxxxxx
> > Signed-off-by: Jules Maselbas <jmaselbas@xxxxxxxxx>
> > ---
>
>
> >
> > printk_rb_static
> > diff --git a/Documentation/admin-guide/media/vivid.rst b/Documentation/admin-guide/media/vivid.rst
> > index 4f680dc9661c..a5a9c062b23f 100644
> > --- a/Documentation/admin-guide/media/vivid.rst
> > +++ b/Documentation/admin-guide/media/vivid.rst
> > @@ -392,7 +392,7 @@ Which one is returned depends on the chosen channel, each next valid channel
> > will cycle through the possible audio subchannel combinations. This allows
> > you to test the various combinations by just switching channels..
> >
> > -Finally, for these inputs the v4l2_timecode struct is filled in in the
> > +Finally, for these inputs the v4l2_timecode struct is filled in the
>
> FYI, this does not look like a typo. It reads as if the filling in happens
> in the dequeued struct.
You're right, I tought the same when seeing this elsewere, this is a mistake.

>
> > dequeued v4l2_buffer struct.
> >
> >
>
> > diff --git a/Documentation/virt/uml/user_mode_linux_howto_v2.rst b/Documentation/virt/uml/user_mode_linux_howto_v2.rst
> > index af2a97429692..ce67a03a7c80 100644
> > --- a/Documentation/virt/uml/user_mode_linux_howto_v2.rst
> > +++ b/Documentation/virt/uml/user_mode_linux_howto_v2.rst
> > @@ -1090,7 +1090,7 @@ be formatted as plain text.
> >
> > Developing always goes hand in hand with debugging. First of all,
> > you can always run UML under gdb and there will be a whole section
> > -later on on how to do that. That, however, is not the only way to
>
> And neither is this. It means that there will be a later section that
> explains how to do it. Possibly there should be some punctuation in
> between though.
Yeah... I personally think that this reads badly but I don't mind dropping
this change.

>
> > +later on how to do that. That, however, is not the only way to
> > debug a Linux kernel. Quite often adding tracing statements and/or
> > using UML specific approaches such as ptracing the UML kernel process
> > are significantly more informative.
>
> Thanks,
> Conor.
>
>