Re: [PATCH] PCI: Fixed spelling in Documentation/PCI/pci.rst

From: Abdul Rahim
Date: Sat Sep 07 2024 - 06:12:08 EST


On Fri, Sep 06, 2024 at 02:24:29PM GMT, Bjorn Helgaas wrote:
> 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@xxxxxxxxxxx> 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@xxxxxxxxxxx>
> > > >> > ---
> > > >> > 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
>

Thanks for reviewing, i've resent this patch here:
https://lore.kernel.org/lkml/20240906205656.8261-1-abdul.rahim@xxxxxxxxxxx/