[PATCH] docs: reporting-issues: clarify advice wording

Chen-Shi-Hong posted 1 patch 1 month ago
Documentation/admin-guide/reporting-issues.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
[PATCH] docs: reporting-issues: clarify advice wording
Posted by Chen-Shi-Hong 1 month ago
A previous change replaced "these advices" with "this advice", but that
wording can be read too narrowly and may seem to refer only to a single
recommendation.

Use "all of this advice" instead to make it clearer that the sentence
refers to the broader set of recommendations in the paragraph.

Signed-off-by: Chen-Shi-Hong <eric039eric@gmail.com>
---
 Documentation/admin-guide/reporting-issues.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/admin-guide/reporting-issues.rst b/Documentation/admin-guide/reporting-issues.rst
index 731865b5e8ff..87dd874fffcf 100644
--- a/Documentation/admin-guide/reporting-issues.rst
+++ b/Documentation/admin-guide/reporting-issues.rst
@@ -129,7 +129,7 @@ After these preparations you'll now enter the main part:
    situations; during the merge window that actually might be even the best
    approach, but in that development phase it can be an even better idea to
    suspend your efforts for a few days anyway. Whatever version you choose,
-   ideally use a 'vanilla' build. Ignoring this advice will dramatically
+   ideally use a 'vanilla' build. Ignoring all of this advice will dramatically
    increase the risk your report will be rejected or ignored.
 
  * Ensure the kernel you just installed does not 'taint' itself when
@@ -795,7 +795,7 @@ Install a fresh kernel for testing
     situations; during the merge window that actually might be even the best
     approach, but in that development phase it can be an even better idea to
     suspend your efforts for a few days anyway. Whatever version you choose,
-    ideally use a 'vanilla' built. Ignoring this advice will dramatically
+    ideally use a 'vanilla' built. Ignoring all of this advice will dramatically
     increase the risk your report will be rejected or ignored.*
 
 As mentioned in the detailed explanation for the first step already: Like most
-- 
2.53.0
Re: [PATCH] docs: reporting-issues: clarify advice wording
Posted by Thorsten Leemhuis 1 month ago
On 5/12/26 17:04, Chen-Shi-Hong wrote:
> A previous change

You mean the one you sent earlier we discussed? But that was not
applied, unless I'm missing something. So this should have been a v2 of
your patch (which a changelog) and against the same base (the one that
"these advices"). You want to send that as v3 now.

> replaced "these advices" with "this advice", but that
> wording can be read too narrowly and may seem to refer only to a single
> recommendation.
> 
> Use "all of this advice" instead

That's great, thx. And thx to Jonathan for the suggestion!

Ciao, Thorsten

> to make it clearer that the sentence
> refers to the broader set of recommendations in the paragraph.
> 
> Signed-off-by: Chen-Shi-Hong <eric039eric@gmail.com>
> ---
>  Documentation/admin-guide/reporting-issues.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/admin-guide/reporting-issues.rst b/Documentation/admin-guide/reporting-issues.rst
> index 731865b5e8ff..87dd874fffcf 100644
> --- a/Documentation/admin-guide/reporting-issues.rst
> +++ b/Documentation/admin-guide/reporting-issues.rst
> @@ -129,7 +129,7 @@ After these preparations you'll now enter the main part:
>     situations; during the merge window that actually might be even the best
>     approach, but in that development phase it can be an even better idea to
>     suspend your efforts for a few days anyway. Whatever version you choose,
> -   ideally use a 'vanilla' build. Ignoring this advice will dramatically
> +   ideally use a 'vanilla' build. Ignoring all of this advice will dramatically
>     increase the risk your report will be rejected or ignored.
>  
>   * Ensure the kernel you just installed does not 'taint' itself when
> @@ -795,7 +795,7 @@ Install a fresh kernel for testing
>      situations; during the merge window that actually might be even the best
>      approach, but in that development phase it can be an even better idea to
>      suspend your efforts for a few days anyway. Whatever version you choose,
> -    ideally use a 'vanilla' built. Ignoring this advice will dramatically
> +    ideally use a 'vanilla' built. Ignoring all of this advice will dramatically
>      increase the risk your report will be rejected or ignored.*
>  
>  As mentioned in the detailed explanation for the first step already: Like most
[PATCH v3] docs: reporting-issues: replace "these advices" with "all of this advice"
Posted by Chen-Shi-Hong 1 month ago
"Advice" is an uncountable noun, so "these advices" is grammatically
incorrect.

Replace it with "all of this advice" instead, which keeps the sentence
grammatical while also making it clear that it refers to the full set of
recommendations in the paragraph.

Signed-off-by: Chen-Shi-Hong <eric039eric@gmail.com>

v3:
- resend against the original base as requested
- replace "these advices" directly with "all of this advice"

v2:
- use "all of this advice" based on review feedback

---
 Documentation/admin-guide/reporting-issues.rst | 4 ++--

 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/admin-guide/reporting-issues.rst b/Documentation/admin-guide/reporting-issues.rst
index 16a66a1f1975..87dd874fffcf 100644
--- a/Documentation/admin-guide/reporting-issues.rst
+++ b/Documentation/admin-guide/reporting-issues.rst
@@ -129,7 +129,7 @@ After these preparations you'll now enter the main part:
    situations; during the merge window that actually might be even the best
    approach, but in that development phase it can be an even better idea to
    suspend your efforts for a few days anyway. Whatever version you choose,
-   ideally use a 'vanilla' build. Ignoring these advices will dramatically
+   ideally use a 'vanilla' build. Ignoring all of this advice will dramatically
    increase the risk your report will be rejected or ignored.
 
  * Ensure the kernel you just installed does not 'taint' itself when
@@ -795,7 +795,7 @@ Install a fresh kernel for testing
     situations; during the merge window that actually might be even the best
     approach, but in that development phase it can be an even better idea to
     suspend your efforts for a few days anyway. Whatever version you choose,
-    ideally use a 'vanilla' built. Ignoring these advices will dramatically
+    ideally use a 'vanilla' built. Ignoring all of this advice will dramatically
     increase the risk your report will be rejected or ignored.*
 
 As mentioned in the detailed explanation for the first step already: Like most
-- 
2.53.0
Re: [PATCH v3] docs: reporting-issues: replace "these advices" with "all of this advice"
Posted by Jonathan Corbet 1 month ago
Chen-Shi-Hong <eric039eric@gmail.com> writes:

You are getting closer, a couple of other details...

> "Advice" is an uncountable noun, so "these advices" is grammatically
> incorrect.
>
> Replace it with "all of this advice" instead, which keeps the sentence
> grammatical while also making it clear that it refers to the full set of
> recommendations in the paragraph.
>
> Signed-off-by: Chen-Shi-Hong <eric039eric@gmail.com>
>
> v3:
> - resend against the original base as requested
> - replace "these advices" directly with "all of this advice"
>
> v2:
> - use "all of this advice" based on review feedback

It is good to include the changes with each version, but it should go
below the "---" line so that the maintainer doesn't have to edit it out
at apply time.

> ---
>  Documentation/admin-guide/reporting-issues.rst | 4 ++--
>
>  1 file changed, 2 insertions(+), 2 deletions(-)

Also, please send new versions as a separate thread rather than as a
response to a previous posting.

Thanks,

jon