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

From: Jonathan Cameron <jic23@kernel.org>
To: Ye Xiang <xiang.ye@intel.com>
Cc: jikos@kernel.org, srinivas.pandruvada@linux.intel.com,
	linux-input@vger.kernel.org, linux-iio@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3 3/3] iio:Documentation: Add documentation for hinge sensor channels
Date: Sat, 5 Dec 2020 16:05:40 +0000	[thread overview]
Message-ID: <20201205160540.22d2b8d5@archlinux> (raw)
In-Reply-To: <20201203035352.13918-4-xiang.ye@intel.com>

On Thu,  3 Dec 2020 11:53:52 +0800
Ye Xiang <xiang.ye@intel.com> wrote:

> Add channel description for hinge sensor, including channel label
> attribute and raw data description.
> 
> Signed-off-by: Ye Xiang <xiang.ye@intel.com>
> ---
>  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@vger.kernel.org
>  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
> +KernelVersion:	5.12
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		Angle of rotation for channel Y. Units after application of scale
> +		and offset are radians.

This entry is already mostly in the doc around line 200, just without the index.
Please just add the What: line to that block to reduce repetition.
If you want to add... "Where present, Y indexes the channel." or something like
that feel free.

> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_anglY_label
> +KernelVersion:	5.12
> +Contact:	linux-iio@vger.kernel.org
> +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.

Makes sense to keep this block separate given the additional info provided.
Alternative would be to add it to the one with in_voltageY_label which would
be odd given what follows!

Thanks,

Jonathan