mirros/rockchip-kernel
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: iio: fix bullet list formatting

Browse Source 
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 <luca@lucaceresoli.net>
Link: https://lore.kernel.org/r/20210215143511.25471-5-luca@lucaceresoli.net
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
This commit is contained in:
Luca Ceresoli
2021-02-15 15:35:10 +01:00
committed by Jonathan Cameron
parent bd9a013d29
commit 218977dcdb
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/driver-api/iio/buffers.rst
View File

@@ -38,15 +38,16 @@ attributes of the following form:
* :file:`type`, description of the scan element data storage within the buffer * :file:`type`, description of the scan element data storage within the buffer
and hence the form in which it is read from user space. and hence the form in which it is read from user space.
Format is [be|le]:[s|u]bits/storagebitsXrepeat[>>shift] . Format is [be|le]:[s|u]bits/storagebitsXrepeat[>>shift] .
* *be* or *le*, specifies big or little endian. * *be* or *le*, specifies big or little endian.
* *s* or *u*, specifies if signed (2's complement) or unsigned. * *s* or *u*, specifies if signed (2's complement) or unsigned.
* *bits*, is the number of valid data bits. * *bits*, is the number of valid data bits.
* *storagebits*, is the number of bits (after padding) that it occupies in the * *storagebits*, is the number of bits (after padding) that it occupies in the
buffer. buffer.
* *shift*, if specified, is the shift that needs to be applied prior to
masking out unused bits.
* *repeat*, specifies the number of bits/storagebits repetitions. When the * *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 For example, a driver for a 3-axis accelerometer with 12 bit resolution where
data is stored in two 8-bits registers as follows:: 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:: include/linux/iio/buffer.h
.. kernel-doc:: drivers/iio/industrialio-buffer.c .. kernel-doc:: drivers/iio/industrialio-buffer.c
:export: :export: