Here are a few minor fixes and improvements to the IIO documentation.
Luca Ceresoli (5):
docs: iio: fix example formatting
docs: iio: fix directory naming
docs: iio: document the 'index' attribute too
docs: iio: fix bullet list formatting
docs: iio: mark "repeat" sysfs attribute as optional
Documentation/driver-api/iio/buffers.rst | 15 ++++++++-------
Documentation/iio/iio_configfs.rst | 2 +-
2 files changed, 9 insertions(+), 8 deletions(-)
--
2.30.0
Two out of three attributes are documented, document the third one too.
Signed-off-by: Luca Ceresoli <[email protected]>
---
Documentation/driver-api/iio/buffers.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/driver-api/iio/buffers.rst b/Documentation/driver-api/iio/buffers.rst
index 9f7dc245d37a..9dad7c94034b 100644
--- a/Documentation/driver-api/iio/buffers.rst
+++ b/Documentation/driver-api/iio/buffers.rst
@@ -34,6 +34,7 @@ attributes of the following form:
* :file:`enable`, used for enabling a channel. If and only if its attribute
is non *zero*, then a triggered capture will contain data samples for this
channel.
+* :file:`index`, the scan_index of the channel.
* :file:`type`, description of the scan element data storage within the buffer
and hence the form in which it is read from user space.
Format is [be|le]:[s|u]bits/storagebitsXrepeat[>>shift] .
--
2.30.0
On Mon, 15 Feb 2021 15:35:06 +0100
Luca Ceresoli <[email protected]> wrote:
> Here are a few minor fixes and improvements to the IIO documentation.
>
> Luca Ceresoli (5):
> docs: iio: fix example formatting
> docs: iio: fix directory naming
> docs: iio: document the 'index' attribute too
> docs: iio: fix bullet list formatting
> docs: iio: mark "repeat" sysfs attribute as optional
>
> Documentation/driver-api/iio/buffers.rst | 15 ++++++++-------
> Documentation/iio/iio_configfs.rst | 2 +-
> 2 files changed, 9 insertions(+), 8 deletions(-)
>
Applied to the togreg branch of iio.git and pushed out as testing
for reasons not particularly related to these patches (though I guess
0-day might do a docs build occasionally)
Jonathan