Message-ID: <3716b1d7-71d5-4e53-9004-c75fc9424a57@leemhuis.info>
Date: Thu, 15 Aug 2024 15:27:00 +0200
From: Thorsten Leemhuis <linux@...mhuis.info>
To: SurajSonawane2415 <surajsonawane0215@...il.com>
Cc: corbet@....net, linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] docs: Fix grammar and phrasing errors in
 reporting-issues.rst

Lo! Thx again for doing this. 

You might want to add a version to the subject (see the -v option for
'git format-patch', which I assume you used to prepare the mail), it
helps to avoid confusion and some maintainers are picky there -- but I
guess Jonathan might not care too much for a simple patch like this.
Some maintainers also would have insisted on a changelog below the
 "---" line; again, for a simple patch like this it likely is not
important.

On 15.08.24 12:31, SurajSonawane2415 wrote:
> This patch corrects some grammatical errors in the `reporting-issues.rst` 
> documentation file. These changes improve the readability and accuracy of 
> the instructions provided in the documentation.

Please use imperative mood, which
https://docs.kernel.org/process/submitting-patches.html#describe-your-changes
describes better then I can do that quickly here.

> Signed-off-by: SurajSonawane2415 <surajsonawane0215@...il.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 2fd5a0302..61de4454b 100644
> --- a/Documentation/admin-guide/reporting-issues.rst
> +++ b/Documentation/admin-guide/reporting-issues.rst
> @@ -56,7 +56,7 @@ developers. It might be all that's needed for people already familiar with
>  reporting issues to Free/Libre & Open Source Software (FLOSS) projects. For
>  everyone else there is this section. It is more detailed and uses a
>  step-by-step approach. It still tries to be brief for readability and leaves
> -out a lot of details; those are described below the step-by-step guide in a
> +out a lot of details; those are described below in the step-by-step guide in a
>  reference section, which explains each of the steps in more detail.
>  
>  Note: this section covers a few more aspects than the TL;DR and does things in
> @@ -299,7 +299,7 @@ face, even if they look small or totally unrelated. That's why you should report
>  issues with these kernels to the vendor. Its developers should look into the
>  report and, in case it turns out to be an upstream issue, fix it directly
>  upstream or forward the report there. In practice that often does not work out
> -or might not what you want. You thus might want to consider circumventing the
> +or might not be what you want. You thus might want to consider circumventing the
>  vendor by installing the very latest Linux kernel core yourself. If that's an
>  option for you move ahead in this process, as a later step in this guide will
>  explain how to do that once it rules out other potential causes for your issue.

Looks fine. But you dropped this change from your earlier patch
afaics:

-module not part of the Linux kernel. That why your might need to uninstall the
+module not part of the Linux kernel. That's why you might be need to uninstall the
 packages with such software to get rid of any 3rd party kernel module.

Sorry, guess I was not clear enough what I wanted in my last mail.
Please re-add that change, but this time keep the line wrapping
intact -- which most likely will mean that the "the" and the end
of the changed line needs to go to the beginning of the next line.

Ciao, Thorsten

Powered by blists - more mailing lists