Re: [PATCH v2] docs: verify/bisect: fix typos

[Manuel Ebner]

On Wed, 2026-09-02 at 18:30 +0200, Thorsten Leemhuis wrote:
> Thx for doing this, much appreciated.
> 
> On 9/2/26 13:51, Manuel Ebner wrote:
> > 'your' -> 'you have'
> > 'kernel kernel' -> 'kernel'
> > 'your' -> 'you' twice
> > 'if is not listed' -> 'if it is not listed'
> > 'hay attention' -> 'pay attention'
> > remove needless "'" in sphinx link
> > 'as disabling then will reduce the consumed disk space'
> >               vvvv
> > 'as disabling them will reduce the consumed disk space'
> > 'You for example might' -> 'For example you might'
> > 'and not from a one that' -> 'and not from one that'
> 
> Pretty sure the above won't fly as a patch description, as it should
> describe the changes, not list each of them, as that is visible from the
> diff already (even if that's slightly hard for text-only files).

That's true, I got this a couple times as feedback.

> For typos and grammar fixes there is not much to say, so maybe just
> state that; but you might want to look at a few recent changes in
> Documentation/ to see how other developers approach a situation like this.

That's a good idea. I did only find slightly more verbose than mine, eg:
> Fix 'hay attention' -> 'pay attention' in file.rst
or
> Replace "an a few" with "and a few" in
> Documentation/driver-api/media/drivers/zoran.rst.

> > Signed-off-by: Manuel Ebner <manuelebnerli@xxxxxxxxxxx>
> > Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> > ---
> > [v2]
> >  + one more 'your' -> 'you'
> >  - 'it'
> >  + incorporate Randy's suggestions
> >     https://lore.kernel.org/all/0475c09c-e165-41a5-b654-5c6aefeaab0b@xxxxxxxxxxxxx/
> >  + Reviewed-by: Randy Dunlap
> > 
> > [v1]
> >  https://lore.kernel.org/all/20260829055501.581856-2-manuelebnerli@xxxxxxxxxxx/
> > 
> > Wouldn't it make sense to add how to skip pure documentation and formating
> > commits?
> 
> YMMV, but I don't think that's worth it. It is easy to get wrong,
> doesn't matter much at the early steps of a bisection, and means one
> more instruction to describe for people that do that for the first time.

Ok.

> > Commits like this one. Or is it better to keep the document short
> > and simple - which it already isn't anymore.
> 
> Feel free to suggest something to remove or rewrite parts with less
> words 

I'll add it to my list, but it's pretty difficult.

> -- in separate patches of course. I know my writing is pretty
> verbose, sorry; partly that's my style, partly it might be because I'm
> not a native speaker, and partly it's like that because I know about too
> many corner cases that I try to prevent users running into.

That´s a feature.

> > ---
> >  .../verify-bugs-and-bisect-regressions.rst    | 24 +++++++++----------
> >  1 file changed, 12 insertions(+), 12 deletions(-)
> > 
> > diff --git a/Documentation/admin-guide/verify-bugs-and-bisect-regressions.rst
> > b/Documentation/admin-guide/verify-bugs-and-bisect-regressions.rst
> > index 7d38393f31f..9296e3f5410 100644
> > --- a/Documentation/admin-guide/verify-bugs-and-bisect-regressions.rst
> > +++ b/Documentation/admin-guide/verify-bugs-and-bisect-regressions.rst
> > @@ -163,7 +163,7 @@ will be considered the 'good' release and used to prepare the .config file.
> >       section 'Complementary tasks: cleanup during and after the process'
> >       below.
> >  
> > -  d) Once your finished the bisection, put a few things away::
> > +  d) Once you have finished the bisection, put a few things away::
> >  
> >         cd ~/linux/
> >         git bisect log > ~/bisect-log
> > @@ -178,8 +178,8 @@ will be considered the 'good' release and used to prepare the .config file.
> >         ./scripts/config --set-str CONFIG_LOCALVERSION '-local-cafec0cacaca0-reverted'
> >  
> >      This is optional, as some commits are impossible to revert. But if the
> > -    second command worked flawlessly, build, install, and boot one more kernel
> > -    kernel; just this time skip the first command copying the base .config file
> > +    second command worked flawlessly, build, install, and boot one more kernel;
> > +    just this time skip the first command copying the base .config file
> >      over, as that already has been taken care off.
> 
> I'd move the "over, " to the previous line, as the formatting otherwise
> looks odd. Not strictly required and makes the patch slightly more
> complex (so might not be the best idea, but I think it's worth when it's
> just one line).

I'd do the same, prior feedback taught me otherwise. I'll do it.

The remaining suggestions are good, will incorporate them.

Thanks
 Manuel 

> >  ...
> ...
> Ciao, Thorsten