linux-kernel - Re: [PATCH v4] docs: Fix grammar and phrasing errors in reporting-issues.rst

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <87le0j54a7.fsf@trenco.lwn.net>
Date: Mon, 26 Aug 2024 16:05:04 -0600
From: Jonathan Corbet <corbet@....net>
To: SurajSonawane2415 <surajsonawane0215@...il.com>, linux@...mhuis.info
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 SurajSonawane2415 <surajsonawane0215@...il.com>
Subject: Re: [PATCH v4] docs: Fix grammar and phrasing errors in
 reporting-issues.rst

SurajSonawane2415 <surajsonawane0215@...il.com> writes:

> Fix grammatical errors and improve phrasing in the `reporting-issues.rst`
> documentation file. These changes enhance readability and ensure the
> accuracy of the instructions provided.
>
> Signed-off-by: SurajSonawane2415 <surajsonawane0215@...il.com>
> ---
> V3 -> V4: Adjust line wrapping to split the long line properly.
> V2 -> V3: Re-added the fix for the line: "That's why you might be need to uninstall the".
> V1 -> V2: Removed the unwanted change to the line: "try search terms like".
>
>  Documentation/admin-guide/reporting-issues.rst | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)

So I have been trying for a while to apply this, but have not succeeded.
It has a number of weird white-space errors.  For example...

> diff --git a/Documentation/admin-guide/reporting-issues.rst b/Documentation/admin-guide/reporting-issues.rst
> index 2fd5a030235a..d0e645fc845a 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. 

There is a spurious space after "detail." that makes things fail.
Fixing that was not sufficient, though, there are others, and I don't
have the time to figure it all out.

Please go through the exercise of emailing the patch to yourself, and
get to the point where "git am" will accept it; then resend.

Thanks,

jon