linux-kernel - Re: [PATCH] PCI: Fixed spelling in Documentation/PCI/pci.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] [thread-next>] [day] [month] [year] [list]

Message-ID: <20240906192429.GA430486@bhelgaas>
Date: Fri, 6 Sep 2024 14:24:29 -0500
From: Bjorn Helgaas <helgaas@...nel.org>
To: Abdul Rahim <abdul.rahim@...ahoo.com>
Cc: Jonathan Corbet <corbet@....net>, bhelgaas@...gle.com,
	linux-kernel@...r.kernel.org, linux-pci@...r.kernel.org,
	linux-doc@...r.kernel.org
Subject: Re: [PATCH] PCI: Fixed spelling in Documentation/PCI/pci.rst

On Sat, Sep 07, 2024 at 12:44:13AM +0530, Abdul Rahim wrote:
> On Fri, Sep 06, 2024 at 12:53:18PM GMT, Jonathan Corbet wrote:
> > Abdul Rahim <abdul.rahim@...ahoo.com> writes:
> > 
> > > On Fri, Sep 06, 2024 at 11:41:52AM GMT, Bjorn Helgaas wrote:
> > >> On Fri, Sep 06, 2024 at 06:15:18PM +0530, Abdul Rahim wrote:
> > >> > Fixed spelling and edited for clarity.
> > >> > 
> > >> > Signed-off-by: Abdul Rahim <abdul.rahim@...ahoo.com>
> > >> > ---
> > >> >  Documentation/PCI/pci.rst | 2 +-
> > >> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > >> > 
> > >> > diff --git a/Documentation/PCI/pci.rst b/Documentation/PCI/pci.rst
> > >> > index dd7b1c0c21da..344c2c2d94f9 100644
> > >> > --- a/Documentation/PCI/pci.rst
> > >> > +++ b/Documentation/PCI/pci.rst
> > >> > @@ -52,7 +52,7 @@ driver generally needs to perform the following initialization:
> > >> >    - Enable DMA/processing engines
> > >> >  
> > >> >  When done using the device, and perhaps the module needs to be unloaded,
> > >> > -the driver needs to take the follow steps:
> > >> > +the driver needs to perform the following steps:
> > >> 
> > >> I don't see a spelling fix here, and personally I wouldn't bother with
> > >> changing "take" to "perform" unless we have other more significant
> > >> changes to make at the same time.
> > >
> > > - "follow" has been corrected to "following", which is more appriopriate
> > > in this context.
> > > - I know its trivial, but can disturb the readers flow
> > > - do you want me to change the message to "Edited for clarity"
> > 
> > The problem is not s/follow/following/, it is the other, unrelated
> > change you made that does not improve the text.  There are reasons why
> > we ask people not to mix multiple changes.  If you submit just the
> > "following" fix, it will surely be applied.
> 
> Understood, will take care next time. I will resend this patch with:
> "follow" -> "following", with commit message "Fixed spelling"

Sorry I missed the "follow" change, which is indeed worth fixing.  If
you resend it, make your subject and commit log say "fix" (not
"fixed"), like it's a command.

https://chris.beams.io/posts/git-commit/
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/maintainer-tip.rst?id=v6.9#n134