linux-kernel - Re: [PATCH v2 1/2] Documentation: misc-devices: Fix indentation, formatting, and update outdated info

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]

Date:   Wed, 7 Apr 2021 19:35:16 +0200
From:   Greg Kroah-Hartman <gregkh@...uxfoundation.org>
To:     Gustavo Pimentel <Gustavo.Pimentel@...opsys.com>
Cc:     "linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>,
        "linux-pci@...r.kernel.org" <linux-pci@...r.kernel.org>,
        "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
        Derek Kiernan <derek.kiernan@...inx.com>,
        Dragan Cvetic <dragan.cvetic@...inx.com>,
        Arnd Bergmann <arnd@...db.de>,
        Andrew Morton <akpm@...ux-foundation.org>,
        Jonathan Corbet <corbet@....net>,
        Bjorn Helgaas <bhelgaas@...gle.com>,
        Krzysztof Wilczyński <kw@...ux.com>,
        Stephen Rothwell <sfr@...b.auug.org.au>
Subject: Re: [PATCH v2 1/2] Documentation: misc-devices: Fix indentation,
 formatting, and update outdated info

On Wed, Apr 07, 2021 at 03:57:31PM +0000, Gustavo Pimentel wrote:
> On Wed, Apr 7, 2021 at 7:17:12, Greg Kroah-Hartman 
> <gregkh@...uxfoundation.org> wrote:
> 
> > On Tue, Apr 06, 2021 at 11:17:48PM +0200, Gustavo Pimentel wrote:
> > > Fixes indentation issues reported by doing *make htmldocs* as well some
> > > text formatting.
> > > 
> > > Besides these fixes, there was some outdated information related to stop
> > > file interface in sysfs.
> > 
> > You are not doing this for all "misc-devices", you are doing this only
> > for one specific driver file.
> > 
> > Please look at the example I provided for how to name this and fix up.
> 
> Sorry Greg, I didn't see an example provided. Perhaps you forgot it?

Nope: https://lore.kernel.org/r/YGyl7OWHJm1NuaV2@kroah.com

> 
> > 
> > > 
> > > Fixes: e1181b5bbc3c ("Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver")
> > > Link: https://urldefense.com/v3/__https://lore.kernel.org/linux-next/20210406214615.40cf3493@canb.auug.org.au/__;!!A4F2R9G_pg!MeIXpmOYi4yJTBq19JEADll7-g6cYBmmwG92EWipqsBiPzeubfMGVllrpMt8FpwvW5ZemHY$ 
> > > Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
> > > Signed-off-by: Gustavo Pimentel <gustavo.pimentel@...opsys.com>
> > > ---
> > >  Documentation/misc-devices/dw-xdata-pcie.rst | 62 +++++++++++++++++++---------
> > >  1 file changed, 43 insertions(+), 19 deletions(-)
> > 
> > What changed from v1?  Always put that below the --- line.
> 
> I've considered the V1 the 2 patches sent wrongly separately, based on 
> your feedback I've generated a v2 to include the cover letter and the 
> reported-by, link, and fixes tags.
> Was this wrong?

No, but you need to say that here, otherwise how do we know this?

> I also placed the change list on the cover letter. Or do you prefer on 
> each patch?

Ah, if you put it in the cover letter, that's fine, but I almost never
read them :)

thanks,

greg k-h