Re: [PATCH 3/5] docs: i2c: convert to ReST and add to driver-api bookset

Alexandre Belloni
2019-06-28T22:10:31Z

On 28/06/2019 18:54:45-0300, Mauro Carvalho Chehab wrote:
> Em Fri, 28 Jun 2019 23:41:38 +0200
> Alexandre Belloni <alexandre.belloni@bootlin.com> escreveu:
>
> > On 28/06/2019 18:23:14-0300, Mauro Carvalho Chehab wrote:
> > > diff --git a/drivers/rtc/rtc-ds1374.c b/drivers/rtc/rtc-ds1374.c
> > > index 225a8df1d4e9..1803f3cab39f 100644
> > > --- a/drivers/rtc/rtc-ds1374.c
> > > +++ b/drivers/rtc/rtc-ds1374.c
> > > @@ -14,7 +14,7 @@
> > > */
> > > /*
> > > * It would be more efficient to use i2c msgs/i2c_transfer directly but, as
> > > - * recommened in .../Documentation/i2c/writing-clients section
> > > + * recommened in .../Documentation/i2c/writing-clients.rst section
> > > * "Sending and receiving", using SMBus level communication is preferred.
> > > */
> > >
> >
> > Honestly, the whole comment could be removed. The current trend is to
> > move everything to regmap anyway.
> >
> > However, I'm fine with that change if you want to keep it that way (and
> > probably scripted).
>
> While the conversion was manually made, the renames were scripted,
> and checked with:
>
> ./scripts/documentation-file-ref-check
>
> Otherwise I would very likely fix the typo:
>
> recommened -> recommended
>
> :-)
>
> I can certainly add new patch at this (before or after patch 3/5 - as you
> prefer) in order to get rid of the comment, but I would avoid doing a
> somewhat unrelated changes at the same documentation patch.
>

I'm okay with that.

--
Alexandre Belloni, Bootlin
Embedded Linux and Kernel engineering