Subject: [PATCH] iio: Documentation: Add trigger name attribute ABI documentation

This patch adds an entry in the ABI Documentation for the
name attribute issued when a trigger is created.

Signed-off-by: Cristina Opriceana <[email protected]>
---
Documentation/ABI/testing/sysfs-bus-iio-trigger-sysfs | 9 +++++++++
1 file changed, 9 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-trigger-sysfs b/Documentation/ABI/testing/sysfs-bus-iio-trigger-sysfs
index 5235e6c..85c8e4d 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio-trigger-sysfs
+++ b/Documentation/ABI/testing/sysfs-bus-iio-trigger-sysfs
@@ -9,3 +9,12 @@ Description:
automated testing or in situations, where other trigger methods
are not applicable. For example no RTC or spare GPIOs.
X is the IIO index of the trigger.
+
+What: /sys/bus/iio/devices/triggerX/name
+KernelVersion: 2.6.39
+Contact: [email protected]
+Description:
+ The name attribute holds a description string for the current
+ trigger. A device should write this name string to
+ /sys/bus/iio/devices/iio:deviceX/trigger/current_trigger
+ in order to use this trigger.
--
1.9.1


2015-08-06 07:33:15

by Daniel Baluta

[permalink] [raw]
Subject: Re: [PATCH] iio: Documentation: Add trigger name attribute ABI documentation

+ linux-iio.

On Wed, Aug 5, 2015 at 8:09 PM, Cristina Opriceana
<[email protected]> wrote:
> This patch adds an entry in the ABI Documentation for the
> name attribute issued when a trigger is created.
>
> Signed-off-by: Cristina Opriceana <[email protected]>
> ---
> Documentation/ABI/testing/sysfs-bus-iio-trigger-sysfs | 9 +++++++++
> 1 file changed, 9 insertions(+)
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-trigger-sysfs b/Documentation/ABI/testing/sysfs-bus-iio-trigger-sysfs
> index 5235e6c..85c8e4d 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio-trigger-sysfs
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-trigger-sysfs
> @@ -9,3 +9,12 @@ Description:
> automated testing or in situations, where other trigger methods
> are not applicable. For example no RTC or spare GPIOs.
> X is the IIO index of the trigger.
> +
> +What: /sys/bus/iio/devices/triggerX/name
> +KernelVersion: 2.6.39
> +Contact: [email protected]
> +Description:
> + The name attribute holds a description string for the current
> + trigger. A device should write this name string to
> + /sys/bus/iio/devices/iio:deviceX/trigger/current_trigger
> + in order to use this trigger.

Better, "In order to associate this trigger with an IIO device one
should write this name string to /sys/bus/...".
Also, please use iio:deviceY instead of iio:deviceX to make it clear
that trigger and device indexes are not
related.

thanks,
Daniel.