aboutsummaryrefslogtreecommitdiff
path: root/Documentation/driver-api/iio
AgeCommit message (Collapse)AuthorFilesLines
2024-08-26doc: iio: Fix sysfs pathsThorsten Scherer2-11/+11
Add missing 'devices' folder in the /sys/bus/iio path. Signed-off-by: Thorsten Scherer <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2021-03-11docs: iio: mark "repeat" sysfs attribute as optionalLuca Ceresoli1-1/+1
Show that this field is optional, just like the shift value. Signed-off-by: Luca Ceresoli <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Cameron <[email protected]>
2021-03-11docs: iio: fix bullet list formattingLuca Ceresoli1-5/+5
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 <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Cameron <[email protected]>
2021-03-11docs: iio: document the 'index' attribute tooLuca Ceresoli1-0/+1
Two out of three attributes are documented, document the third one too. Signed-off-by: Luca Ceresoli <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Cameron <[email protected]>
2021-03-11docs: iio: fix directory namingLuca Ceresoli1-1/+1
This directory is a, well, directory, not a file. Signed-off-by: Luca Ceresoli <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Cameron <[email protected]>
2020-10-15docs: get rid of :c:type explicit declarations for structsMauro Carvalho Chehab5-8/+8
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 <[email protected]> # blk-mq.rst Reviewed-by: Takashi Iwai <[email protected]> # sound Reviewed-by: Mike Rapoport <[email protected]> Reviewed-by: Greg Kroah-Hartman <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-08-24IIO: Documentation: Replace deprecated :c:func: UsagePuranjay Mohan1-8/+8
Replace :c:func: with func() as the previous usage is deprecated. Signed-off-by: Puranjay Mohan <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-07Documentation/driver-api: iio/buffers: drop doubled wordRandy Dunlap1-1/+1
Drop the doubled word "struct". Signed-off-by: Randy Dunlap <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Cc: William Breathitt Gray <[email protected]> Cc: [email protected] Signed-off-by: Jonathan Cameron <[email protected]>
2020-04-19iio: core: drop devm_iio_trigger_free() API callAlexandru Ardelean1-1/+0
It's unused so far, so it can be removed. Also makes sense to remove it to discourage weird uses of this call during review. Signed-off-by: Alexandru Ardelean <[email protected]> Signed-off-by: Jonathan Cameron <[email protected]>
2020-04-19iio: core: drop devm_iio_trigger_unregister() API callAlexandru Ardelean1-1/+0
It's unused so far, so it can be removed. Also makes sense to remove it to discourage weird uses of this call during review. Signed-off-by: Alexandru Ardelean <[email protected]> Signed-off-by: Jonathan Cameron <[email protected]>
2019-05-24docs: Do not seek kerneldoc comments in hw-consumer.hJonathan Corbet1-1/+0
There are no kerneldoc comments here, so looking for them just yields a warning in the docs build. Signed-off-by: Jonathan Corbet <[email protected]>
2019-03-04docs: driver-api: iio: fix errors in documentationTomasz Duszynski4-6/+6
Improve IIO documentation by fixing a few mistakes. Signed-off-by: Tomasz Duszynski <[email protected]> Acked-by: Jonathan Cameron <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-01-10docs: driver-api: add iio hw consumer sectionArnaud Pouliquen2-0/+52
This adds a section about the Hardware consumer API of the IIO subsystem to the driver API documentation. Signed-off-by: Arnaud Pouliquen <[email protected]> Reviewed-by: Jonathan Cameron <[email protected]> Signed-off-by: Mark Brown <[email protected]>
2017-01-04docs: IIO documentation sphinx conversionJonathan Cameron6-0/+506
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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>