linux-kernel - Re: [PATCH] docs: staging: fix typo in docs

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <87r0hmfuhq.fsf@meer.lwn.net>
Date: Thu, 08 Feb 2024 15:42:41 -0700
From: Jonathan Corbet <corbet@....net>
To: Vincenzo Mezzela <vincenzo.mezzela@...il.com>, andersson@...nel.org,
 mathieu.poirier@...aro.org
Cc: linux-remoteproc@...r.kernel.org, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org, skhan@...uxfoundation.org, Vincenzo Mezzela
 <vincenzo.mezzela@...il.com>
Subject: Re: [PATCH] docs: staging: fix typo in docs

Vincenzo Mezzela <vincenzo.mezzela@...il.com> writes:

So your fix is fine, but I need to point out a couple of things with the
changelog.

> This patch resolves a spelling error in the documentation found
> with codespell.

If you look at Documentation/process/submitting-patches.rst, you'll see
that changelog text should be phrased in the imperative mode; no "this
patch".  I tend not to be too fussy about that, but some maintainers
will reject a patch out of hand for that, so it's a good thing to learn
to avoid.

> It is submitted as part of my application to the "Linux Kernel Bug
> Fixing Spring Unpaid 2024" mentorship program of the Linux Kernel
> Foundation.

This is interesting (I'd never heard of the Linux Kernel Foundation),
but it's not really relevant for the kernel development history.  If you
want to put this kind of information in a submission, put it after the
"---" line so that it doesn't end up being committed with the patch.

> Signed-off-by: Vincenzo Mezzela <vincenzo.mezzela@...il.com>

I have gone ahead and fixed up these things and applied your two
patches, thanks.

jon