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]>
---
Documentation/driver-api/iio/buffers.rst | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/Documentation/driver-api/iio/buffers.rst b/Documentation/driver-api/iio/buffers.rst
index 9dad7c94034b..5801caf216a6 100644
--- a/Documentation/driver-api/iio/buffers.rst
+++ b/Documentation/driver-api/iio/buffers.rst
@@ -38,15 +38,16 @@ attributes of the following form:
* :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] .
+
* *be* or *le*, specifies big or little endian.
* *s* or *u*, specifies if signed (2's complement) or unsigned.
* *bits*, is the number of valid data bits.
* *storagebits*, is the number of bits (after padding) that it occupies in the
- buffer.
- * *shift*, if specified, is the shift that needs to be applied prior to
- masking out unused bits.
+ buffer.
* *repeat*, specifies the number of bits/storagebits repetitions. When the
- repeat element is 0 or 1, then the repeat value is omitted.
+ repeat element is 0 or 1, then the repeat value is omitted.
+ * *shift*, if specified, is the shift that needs to be applied prior to
+ masking out unused bits.
For example, a driver for a 3-axis accelerometer with 12 bit resolution where
data is stored in two 8-bits registers as follows::
@@ -123,4 +124,3 @@ More details
.. kernel-doc:: include/linux/iio/buffer.h
.. kernel-doc:: drivers/iio/industrialio-buffer.c
:export:
-
--
2.30.0
On Mon, 15 Feb 2021 15:35:10 +0100
Luca Ceresoli <[email protected]> wrote:
> 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]>
> ---
> Documentation/driver-api/iio/buffers.rst | 10 +++++-----
> 1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/driver-api/iio/buffers.rst b/Documentation/driver-api/iio/buffers.rst
> index 9dad7c94034b..5801caf216a6 100644
> --- a/Documentation/driver-api/iio/buffers.rst
> +++ b/Documentation/driver-api/iio/buffers.rst
> @@ -38,15 +38,16 @@ attributes of the following form:
> * :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] .
> +
> * *be* or *le*, specifies big or little endian.
> * *s* or *u*, specifies if signed (2's complement) or unsigned.
> * *bits*, is the number of valid data bits.
> * *storagebits*, is the number of bits (after padding) that it occupies in the
> - buffer.
> - * *shift*, if specified, is the shift that needs to be applied prior to
> - masking out unused bits.
> + buffer.
> * *repeat*, specifies the number of bits/storagebits repetitions. When the
> - repeat element is 0 or 1, then the repeat value is omitted.
> + repeat element is 0 or 1, then the repeat value is omitted.
> + * *shift*, if specified, is the shift that needs to be applied prior to
> + masking out unused bits.
>
> For example, a driver for a 3-axis accelerometer with 12 bit resolution where
> data is stored in two 8-bits registers as follows::
> @@ -123,4 +124,3 @@ More details
> .. kernel-doc:: include/linux/iio/buffer.h
> .. kernel-doc:: drivers/iio/industrialio-buffer.c
> :export:
> -
This shouldn't be in here really but it's so minor lets not bother fixing it.
Jonathan