From: Jonathan Cameron <jic23@jic23.retrosnub.co.uk>
To: Luca Ceresoli <luca@lucaceresoli.net>
Cc: linux-doc@vger.kernel.org, linux-iio@vger.kernel.org,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Jonathan Cameron <Jonathan.Cameron@huawei.com>
Subject: Re: [PATCH 4/5] docs: iio: fix bullet list formatting
Date: Tue, 16 Feb 2021 20:08:25 +0000 [thread overview]
Message-ID: <20210216200825.3426bb77@archlinux> (raw)
In-Reply-To: <20210215143511.25471-5-luca@lucaceresoli.net>
On Mon, 15 Feb 2021 15:35:10 +0100
Luca Ceresoli <luca@lucaceresoli.net> 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 <luca@lucaceresoli.net>
> ---
> 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
next prev parent reply other threads:[~2021-02-16 20:17 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-15 14:35 [PATCH 0/5] docs: iio: misc fixes and improvements Luca Ceresoli
2021-02-15 14:35 ` [PATCH 1/5] docs: iio: fix example formatting Luca Ceresoli
2021-02-15 14:35 ` [PATCH 2/5] docs: iio: fix directory naming Luca Ceresoli
2021-02-15 14:35 ` [PATCH 3/5] docs: iio: document the 'index' attribute too Luca Ceresoli
2021-02-15 14:35 ` [PATCH 4/5] docs: iio: fix bullet list formatting Luca Ceresoli
2021-02-16 20:08 ` Jonathan Cameron [this message]
2021-02-15 14:35 ` [PATCH 5/5] docs: iio: mark "repeat" sysfs attribute as optional Luca Ceresoli
2021-02-16 20:09 ` [PATCH 0/5] docs: iio: misc fixes and improvements Jonathan Cameron
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210216200825.3426bb77@archlinux \
--to=jic23@jic23.retrosnub.co.uk \
--cc=Jonathan.Cameron@huawei.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=luca@lucaceresoli.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).