Re: [PATCH v8 5/5] nvmem: eeprom: add documentation of sysfs fram and sernum file

[Greg Kroah-Hartman]

On Tue, Jun 08, 2021 at 11:50:03AM +0200, Jiří Prchal wrote:
> 
> 
> On 08. 06. 21 11:05, Greg Kroah-Hartman wrote:
> > On Mon, Jun 07, 2021 at 06:12:01PM +0200, Jiri Prchal wrote:
> > > Added sysfs fram and sernum file documentation.
> > > 
> > > Signed-off-by: Jiri Prchal <jiri.prchal@xxxxxxxxxxx>
> > > ---
> > > v5: new
> > > v6: no change here
> > > v7: no change here
> > > v8: added fram file doc
> > > ---
> > >   Documentation/ABI/testing/sysfs-class-spi-eeprom | 13 +++++++++++++
> > >   1 file changed, 13 insertions(+)
> > >   create mode 100644 Documentation/ABI/testing/sysfs-class-spi-eeprom
> > > 
> > > diff --git a/Documentation/ABI/testing/sysfs-class-spi-eeprom b/Documentation/ABI/testing/sysfs-class-spi-eeprom
> > > new file mode 100644
> > > index 000000000000..b41420fe1329
> > > --- /dev/null
> > > +++ b/Documentation/ABI/testing/sysfs-class-spi-eeprom
> > > @@ -0,0 +1,13 @@
> > > +What:		/sys/class/spi_master/spi<bus>/spi<bus>.<dev>/sernum
> > > +Date:		May 2021
> > > +KernelVersion:	5.13
> > > +Contact:	Jiri Prchal <jiri.prchal@xxxxxxxxxxx>
> > > +Description:
> > > +		(RO) Exports serial number of Cypress FRAM (FM25VN). 8 bytes as is in chip in hex string.
> > 
> > Please properly wrap your lines.
> > 
> > What is "(RO)" here?
> 
> Read Only, as seen in another doc.

Perhaps this should say something like:
	Contains the serial number of the Cypress FRAM (FM25VN) if it is
	present.  It will be displayed as a 8 byte hex string, as read
	from the device.

	This is a read-only attribute.

> > And the grammer is a bit odd, what is the second sentence supposed to
> > mean?
> > 
> > > +
> > > +What:		/sys/class/spi_master/spi<bus>/spi<bus>.<dev>/fram
> > > +Date:		June 2021
> > > +KernelVersion:	5.13
> > 
> > Obviously it can not make 5.13, right?
> 
> Sorry for missunderstanding, what number should be here?

5.14 if all goes well, right?

thanks,

greg k-h