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

From: Greg Kroah-Hartman
Date: Wed Apr 07 2021 - 13:35:24 EST


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@xxxxxxxxxxxxxxxxxxx> 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@xxxxxxxxx

>
> >
> > >
> > > 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@xxxxxxxxxxxxxxxx/__;!!A4F2R9G_pg!MeIXpmOYi4yJTBq19JEADll7-g6cYBmmwG92EWipqsBiPzeubfMGVllrpMt8FpwvW5ZemHY$
> > > Reported-by: Stephen Rothwell <sfr@xxxxxxxxxxxxxxxx>
> > > Signed-off-by: Gustavo Pimentel <gustavo.pimentel@xxxxxxxxxxxx>
> > > ---
> > > 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