[PATCH 14/53] docs: driver-api: iio: avoid using UTF-8 chars
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Date: 2021-05-10 10:31:52
Also in:
lkml
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
While UTF-8 characters can be used at the Linux documentation,
the best is to use them only when ASCII doesn't offer a good replacement.
So, replace the occurences of the following UTF-8 characters:
- U+2014 ('—'): EM DASH
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/driver-api/iio/buffers.rst | 8 ++++----
Documentation/driver-api/iio/hw-consumer.rst | 10 +++++-----
Documentation/driver-api/iio/triggered-buffers.rst | 6 +++---
Documentation/driver-api/iio/triggers.rst | 10 +++++-----
4 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/Documentation/driver-api/iio/buffers.rst b/Documentation/driver-api/iio/buffers.rst
index e83026aebe97..24569ff0cf79 100644
--- a/Documentation/driver-api/iio/buffers.rst
+++ b/Documentation/driver-api/iio/buffers.rst@@ -2,11 +2,11 @@ Buffers ======= -* struct iio_buffer — general buffer structure -* :c:func:`iio_validate_scan_mask_onehot` — Validates that exactly one channel +* struct iio_buffer - general buffer structure +* :c:func:`iio_validate_scan_mask_onehot` - Validates that exactly one channel is selected -* :c:func:`iio_buffer_get` — Grab a reference to the buffer -* :c:func:`iio_buffer_put` — Release the reference to the buffer +* :c:func:`iio_buffer_get` - Grab a reference to the buffer +* :c:func:`iio_buffer_put` - Release the reference to the buffer The Industrial I/O core offers a way for continuous data capture based on a trigger source. Multiple data channels can be read at once from
diff --git a/Documentation/driver-api/iio/hw-consumer.rst b/Documentation/driver-api/iio/hw-consumer.rst
index 76133a3796f2..75986358fc02 100644
--- a/Documentation/driver-api/iio/hw-consumer.rst
+++ b/Documentation/driver-api/iio/hw-consumer.rst@@ -8,11 +8,11 @@ software buffer for data. The implementation can be found under :file:`drivers/iio/buffer/hw-consumer.c` -* struct iio_hw_consumer — Hardware consumer structure -* :c:func:`iio_hw_consumer_alloc` — Allocate IIO hardware consumer -* :c:func:`iio_hw_consumer_free` — Free IIO hardware consumer -* :c:func:`iio_hw_consumer_enable` — Enable IIO hardware consumer -* :c:func:`iio_hw_consumer_disable` — Disable IIO hardware consumer +* struct iio_hw_consumer - Hardware consumer structure +* :c:func:`iio_hw_consumer_alloc` - Allocate IIO hardware consumer +* :c:func:`iio_hw_consumer_free` - Free IIO hardware consumer +* :c:func:`iio_hw_consumer_enable` - Enable IIO hardware consumer +* :c:func:`iio_hw_consumer_disable` - Disable IIO hardware consumer HW consumer setup
diff --git a/Documentation/driver-api/iio/triggered-buffers.rst b/Documentation/driver-api/iio/triggered-buffers.rst
index 417555dbbdf4..7c37b2afa1ad 100644
--- a/Documentation/driver-api/iio/triggered-buffers.rst
+++ b/Documentation/driver-api/iio/triggered-buffers.rst@@ -7,10 +7,10 @@ Now that we know what buffers and triggers are let's see how they work together. IIO triggered buffer setup ========================== -* :c:func:`iio_triggered_buffer_setup` — Setup triggered buffer and pollfunc -* :c:func:`iio_triggered_buffer_cleanup` — Free resources allocated by +* :c:func:`iio_triggered_buffer_setup` - Setup triggered buffer and pollfunc +* :c:func:`iio_triggered_buffer_cleanup` - Free resources allocated by :c:func:`iio_triggered_buffer_setup` -* struct iio_buffer_setup_ops — buffer setup related callbacks +* struct iio_buffer_setup_ops - buffer setup related callbacks A typical triggered buffer setup looks like this::
diff --git a/Documentation/driver-api/iio/triggers.rst b/Documentation/driver-api/iio/triggers.rst
index 288625e40672..a5d1fc15747c 100644
--- a/Documentation/driver-api/iio/triggers.rst
+++ b/Documentation/driver-api/iio/triggers.rst@@ -2,11 +2,11 @@ Triggers ======== -* struct iio_trigger — industrial I/O trigger device -* :c:func:`devm_iio_trigger_alloc` — Resource-managed iio_trigger_alloc -* :c:func:`devm_iio_trigger_register` — Resource-managed iio_trigger_register +* struct iio_trigger - industrial I/O trigger device +* :c:func:`devm_iio_trigger_alloc` - Resource-managed iio_trigger_alloc +* :c:func:`devm_iio_trigger_register` - Resource-managed iio_trigger_register iio_trigger_unregister -* :c:func:`iio_trigger_validate_own_device` — Check if a trigger and IIO +* :c:func:`iio_trigger_validate_own_device` - Check if a trigger and IIO device belong to the same device In many situations it is useful for a driver to be able to capture data based
@@ -63,7 +63,7 @@ Let's see a simple example of how to setup a trigger to be used by a driver:: IIO trigger ops =============== -* struct iio_trigger_ops — operations structure for an iio_trigger. +* struct iio_trigger_ops - operations structure for an iio_trigger. Notice that a trigger has a set of operations attached:
--
2.30.2