Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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

Improve IIO documentation by fixing a few mistakes.

Signed-off-by: Tomasz Duszynski <tduszyns@gmail.com>
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Tomasz Duszynski and committed by
Jonathan Corbet
8c56eebc d2b008f1

+6 -6
+1 -1
Documentation/driver-api/iio/buffers.rst
··· 26 26 ================ 27 27 28 28 The meta information associated with a channel reading placed in a buffer is 29 - called a scan element . The important bits configuring scan elements are 29 + called a scan element. The important bits configuring scan elements are 30 30 exposed to userspace applications via the 31 31 :file:`/sys/bus/iio/iio:device{X}/scan_elements/*` directory. This file contains 32 32 attributes of the following form:
+3 -3
Documentation/driver-api/iio/core.rst
··· 2 2 Core elements 3 3 ============= 4 4 5 - The Industrial I/O core offers a unified framework for writing drivers for 6 - many different types of embedded sensors. a standard interface to user space 5 + The Industrial I/O core offers both a unified framework for writing drivers for 6 + many different types of embedded sensors and a standard interface to user space 7 7 applications manipulating sensors. The implementation can be found under 8 8 :file:`drivers/iio/industrialio-*` 9 9 ··· 11 11 ---------------------- 12 12 13 13 * struct :c:type:`iio_dev` - industrial I/O device 14 - * :c:func:`iio_device_alloc()` - alocate an :c:type:`iio_dev` from a driver 14 + * :c:func:`iio_device_alloc()` - allocate an :c:type:`iio_dev` from a driver 15 15 * :c:func:`iio_device_free()` - free an :c:type:`iio_dev` from a driver 16 16 * :c:func:`iio_device_register()` - register a device with the IIO subsystem 17 17 * :c:func:`iio_device_unregister()` - unregister a device from the IIO
+1 -1
Documentation/driver-api/iio/hw-consumer.rst
··· 1 1 =========== 2 2 HW consumer 3 3 =========== 4 - An IIO device can be directly connected to another device in hardware. in this 4 + An IIO device can be directly connected to another device in hardware. In this 5 5 case the buffers between IIO provider and IIO consumer are handled by hardware. 6 6 The Industrial I/O HW consumer offers a way to bond these IIO devices without 7 7 software buffer for data. The implementation can be found under
+1 -1
Documentation/driver-api/iio/triggers.rst
··· 38 38 39 39 * :file:`/sys/bus/iio/devices/iio:device{X}/trigger/*`, this directory is 40 40 created once the device supports a triggered buffer. We can associate a 41 - trigger with our device by writing the trigger's name in the 41 + trigger with our device by writing the trigger's name in the 42 42 :file:`current_trigger` file. 43 43 44 44 IIO trigger setup