Re: [PATCH v1 1/1] i2c: designware: Fix the kernel doc description for struct dw_i2c_dev

From: Andy Shevchenko
Date: Mon Nov 15 2021 - 09:20:23 EST


On Fri, Nov 12, 2021 at 08:43:16AM -0800, Randy Dunlap wrote:
> On 11/12/21 8:26 AM, Andy Shevchenko wrote:
> > On Fri, Nov 12, 2021 at 6:01 PM Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:
> > > On 11/12/21 4:34 AM, Andy Shevchenko wrote:

...

> > > > + * @rinfo: I²C GPIO recovery information
> > >
> > > Preferably: "I2C"
> >
> > Why?
>
> See below vvvvvvvvvvvvvvvvv:
> > > like it is in thousands of places in the kernel source tree.

When is it good point to start following the spec?

> > UTF-8 has been established for more than a decade. I prefer to use the
> > proper form of the abbreviation (*).
> >
> > *) Check UM10204.pdf.
>
> Yes, I am aware of what is in the spec.

Wolfram, what do you prefer?

--
With Best Regards,
Andy Shevchenko