kernel/Documentation/driver-api/iio/buffers.rst, branch linux-rolling-stable

doc: iio: Fix sysfs paths

2024-08-26T22:13:20Z

Add missing 'devices' folder in the /sys/bus/iio path. Signed-off-by: Thorsten Scherer Signed-off-by: Jonathan Corbet Link: https://lore.kernel.org/r/20240805120357.21135-1-t.scherer@eckelmann.de

docs: iio: mark "repeat" sysfs attribute as optional

2021-03-11T20:47:08Z

Show that this field is optional, just like the shift value. Signed-off-by: Luca Ceresoli Link: https://lore.kernel.org/r/20210215143511.25471-6-luca@lucaceresoli.net Signed-off-by: Jonathan Cameron

docs: iio: fix bullet list formatting

2021-03-11T20:47:08Z

This 2nd-level bullet list is not properly ReST-formatted and thus it gets rendered as a unique paragraph quite unreadable. Fix by adding spaces as needed. While there also swap "shift" and "repeat" so they are in the correct order. Signed-off-by: Luca Ceresoli Link: https://lore.kernel.org/r/20210215143511.25471-5-luca@lucaceresoli.net Signed-off-by: Jonathan Cameron

docs: iio: document the 'index' attribute too

2021-03-11T20:47:08Z

Two out of three attributes are documented, document the third one too. Signed-off-by: Luca Ceresoli Link: https://lore.kernel.org/r/20210215143511.25471-4-luca@lucaceresoli.net Signed-off-by: Jonathan Cameron

docs: iio: fix directory naming

2021-03-11T20:47:07Z

This directory is a, well, directory, not a file. Signed-off-by: Luca Ceresoli Link: https://lore.kernel.org/r/20210215143511.25471-3-luca@lucaceresoli.net Signed-off-by: Jonathan Cameron

docs: get rid of :c:type explicit declarations for structs

2020-10-15T05:49:40Z

The :c:type:`foo` only works properly with structs before Sphinx 3.x. On Sphinx 3.x, structs should now be declared using the .. c:struct, and referenced via :c:struct tag. As we now have the automarkup.py macro, that automatically convert: struct foo into cross-references, let's get rid of that, solving several warnings when building docs with Sphinx 3.x. Reviewed-by: André Almeida # blk-mq.rst Reviewed-by: Takashi Iwai # sound Reviewed-by: Mike Rapoport Reviewed-by: Greg Kroah-Hartman Signed-off-by: Mauro Carvalho Chehab

Documentation/driver-api: iio/buffers: drop doubled word

2020-07-07T19:24:07Z

Drop the doubled word "struct". Signed-off-by: Randy Dunlap Cc: Jonathan Corbet Cc: linux-doc@vger.kernel.org Cc: William Breathitt Gray Cc: linux-iio@vger.kernel.org Signed-off-by: Jonathan Cameron

docs: driver-api: iio: fix errors in documentation

2019-03-04T19:51:17Z

Improve IIO documentation by fixing a few mistakes. Signed-off-by: Tomasz Duszynski Acked-by: Jonathan Cameron Signed-off-by: Jonathan Corbet

docs: IIO documentation sphinx conversion

2017-01-04T20:24:41Z

This is a manual conversion of the existing DocBook documentation for IIO. The intent is not to substantially change any of the content in this patch, but to give a base to build upon. Signed-off-by: Jonathan Cameron Signed-off-by: Jonathan Corbet