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

[Randy Dunlap]

On 8/28/26 10:55 PM, Manuel Ebner wrote:
> 'your' -> 'you' twice.
> 'kernel kernel' -> 'kernel'
> 'hay attention' -> 'pay attention'
> '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'
> 'that create or modify' -> 'that creates or modifies'
> 'and not from a one that' -> 'and not from one that'
> 
> Signed-off-by: Manuel Ebner <manuelebnerli@xxxxxxxxxxx>
> ---
> I could't figure out what the "'" is for, they do show up in the .html.
> Would this be a sane change?

I have no idea about the "'" marks. Dropping them LGTM ... and works
in the html.

> @ -1186,4 +1186,4 @@ safe side, so often you will need less.
>  If you have space constraints, be sure to pay attention to the :ref:`step about
> -debug symbols' <debugsymbols_bissbs>` and its :ref:`accompanying reference
> -section' <debugsymbols_bisref>`, as disabling them will reduce the consumed disk
> +debug symbols <debugsymbols_bissbs>` and its :ref:`accompanying reference
> +section <debugsymbols_bisref>`, as disabling them will reduce the consumed disk
>  space by quite a few gigabytes.
> ---
>  .../verify-bugs-and-bisect-regressions.rst    | 20 +++++++++----------
>  1 file changed, 10 insertions(+), 10 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..43e15b16894 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 finished the bisection, put a few things away::

I prefer:
     d) Once you have finished the bisection, put a few things away::
or maybe
     d) Once you're finished with 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.
>  
>  * **Complementary tasks**: cleanup during and after the process.
> @@ -232,7 +232,7 @@ set to report the bug -- unless it did not happen with earlier kernel versions,
>  as then your want to at least continue with *segment 2* to **check if the issue
>  qualifies as regression** which receive priority treatment. Depending on the
>  outcome you then are ready to report a bug or submit a preliminary regression
> -report; instead of the latter your could also head straight on and follow
> +report; instead of the latter you could also head straight on and follow
>  *segment 3* to **perform a bisection** for a full-fledged regression report
>  developers are obliged to act upon.
>  
> @@ -1183,9 +1183,9 @@ Space requirements
>  The numbers mentioned are rough estimates with a big extra charge to be on the
>  safe side, so often you will need less.
>  
> -If you have space constraints, be sure to hay attention to the :ref:`step about
> +If you have space constraints, be sure to pay attention to the :ref:`step about
>  debug symbols' <debugsymbols_bissbs>` and its :ref:`accompanying reference
> -section' <debugsymbols_bisref>`, as disabling then will reduce the consumed disk
> +section' <debugsymbols_bisref>`, as disabling them will reduce the consumed disk
>  space by quite a few gigabytes.
>  
>  [:ref:`back to step-by-step guide <diskspace_bissbs>`]
> @@ -1254,8 +1254,8 @@ distributions:
>        kernel-install-tools libelf-devel make modutils openssl openssl-devel \
>        perl-base zlib-devel rpm-build ncurses-devel qt6-base-devel
>  
> -These commands install a few packages that are often, but not always needed. You
> -for example might want to skip installing the development headers for ncurses,
> +These commands install a few packages that are often, but not always needed. For
> +example you might want to skip installing the development headers for ncurses,
>  which you will only need in case you later might want to adjust the kernel build
>  configuration using make the targets 'menuconfig' or 'nconfig'; likewise omit
>  the headers of Qt6 if you do not plan to adjust the .config using 'xconfig'.
> @@ -1365,7 +1365,7 @@ Start defining the build configuration for your kernel
>    *Start preparing a kernel build configuration (the '.config' file).*
>    [:ref:`... <oldconfig_bissbs>`]
>  
> -*Note, this is the first of multiple steps in this guide that create or modify
> +*Note, this is the first of multiple steps in this guide that creates or modifies

So you are saying that the "that" clause refers to "first" and that the
verbs should be singular to match "first"?
It has been ages since I diagrammed a sentence. :)
Could the "that" clause be referring to "multiple steps" instead of "first"?

https://www.writecream.com/sentence-diagram-generator/ says that "that" refers
to "steps" so the verbs would be of the plural variety. IDK. [Refer to "ages" above.]


>  build artifacts. The commands used in this guide store them right in the source
>  tree to keep things simple. In case you prefer storing the build artifacts
>  separately, create a directory like '~/linux-builddir/' and add the parameter
> @@ -1407,7 +1407,7 @@ Occasionally odd things happen when trying to use a config file prepared for one
>  kernel (say 6.1) on an older mainline release -- especially if it is much older
>  (say 5.15). That's one of the reasons why the previous step in the guide told
>  you to boot the kernel where everything works. If you manually add a .config
> -file you thus want to ensure it's from the working kernel and not from a one
> +file you thus want to ensure it's from the working kernel and not from one
>  that shows the regression.
>  
>  In case you want to build kernels for another machine, locate its kernel build

All of the other changes LGTM.
Thanks.
-- 
~Randy