Re: [PATCH v3 3/3] iio:Documentation: Add documentation for hinge sensor channels

[Jonathan Cameron]

On Fri, 04 Dec 2020 03:40:15 -0800
Srinivas Pandruvada <srinivas.pandruvada@xxxxxxxxxxxxxxx> wrote:

> On Thu, 2020-12-03 at 11:53 +0800, Ye Xiang wrote:
> > Add channel description for hinge sensor, including channel label
> > attribute and raw data description.
> > 
> > Signed-off-by: Ye Xiang <xiang.ye@xxxxxxxxx>
> > ---
> >  Documentation/ABI/testing/sysfs-bus-iio | 17 +++++++++++++++++
> >  1 file changed, 17 insertions(+)
> > 
> > diff --git a/Documentation/ABI/testing/sysfs-bus-iio
> > b/Documentation/ABI/testing/sysfs-bus-iio
> > index df42bed09f25..82303b1bdff0 100644
> > --- a/Documentation/ABI/testing/sysfs-bus-iio
> > +++ b/Documentation/ABI/testing/sysfs-bus-iio
> > @@ -1802,3 +1802,20 @@ Contact:	linux-iio@xxxxxxxxxxxxxxx
> >  Description:
> >  		Unscaled light intensity according to CIE 1931/DIN 5033
> > color space.
> >  		Units after application of scale are nano nanowatts per
> > square meter.
> > +
> > +What:		/sys/bus/iio/devices/iio:deviceX/in_anglY_raw  
> Channel "Y" doesn't sound to be a variable. Why not just say "*"

Long term convention.  More generally you need a way to refer to the
individual wild cards. Sometimes there are more than the two we have
here.

Not entirely sure where the convention comes from but it is used
throughout this file and I doubt I invented it.

Jonathan


> 
> Thanks,
> Srinivas
> 
> > +KernelVersion:	5.12
> > +Contact:	linux-iio@xxxxxxxxxxxxxxx
> > +Description:
> > +		Angle of rotation for channel Y. Units after
> > application of scale
> > +		and offset are radians.
> > +
> > +What:		/sys/bus/iio/devices/iio:deviceX/in_anglY_label
> > +KernelVersion:	5.12
> > +Contact:	linux-iio@xxxxxxxxxxxxxxx
> > +Description:
> > +		Optional symbolic label for channel Y.
> > +		For Intel hid hinge sensor, the label values are:
> > +		hinge, keyboard, screen. It means the three channels
> > +		each correspond respectively to hinge angle, keyboard
> > angle,
> > +		and screen angle.  
>