From: "Nuno Sá" <nuno.sa@analog.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-kernel@vger.kernel.org,
Olivier Moysan <olivier.moysan@foss.st.com>,
Jonathan Cameron <jic23@kernel.org>,
David Lechner <dlechner@baylibre.com>,
Andy Shevchenko <andy@kernel.org>,
linux-iio@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Shuah Khan <skhan@linuxfoundation.org>,
linux-doc@vger.kernel.org
Subject: Re: [PATCH v2] docs: iio: backend: use literal block for commands
Date: Thu, 17 Sep 2026 09:46:17 +0100 [thread overview]
Message-ID: <aquoqnyKi8BAVyZX@nsa> (raw)
In-Reply-To: <20260916180739.2296401-1-rdunlap@infradead.org>
On Wed, Sep 16, 2026 at 11:07:39AM -0700, Randy Dunlap wrote:
> Use literal blocks for 'cat' and 'echo' commands to separate them from
> the surrounding text. Otherwise the lines run together, without any
> clear break before or after the commands.
>
> Use shell comment style to go along with the shell commands.
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
Reviewed-by: Nuno Sá <nuno.sa@analog.com>
> v2: use shell comment style (Andy)
>
> Cc: Nuno Sa <nuno.sa@analog.com>
> Cc: Olivier Moysan <olivier.moysan@foss.st.com>
> Cc: Jonathan Cameron <jic23@kernel.org>
> Cc: David Lechner <dlechner@baylibre.com>
> Cc: Andy Shevchenko <andy@kernel.org>
> Cc: linux-iio@vger.kernel.org
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Shuah Khan <skhan@linuxfoundation.org>
> Cc: linux-doc@vger.kernel.org
>
> Documentation/ABI/testing/debugfs-iio-backend | 16 ++++++++--------
> 1 file changed, 8 insertions(+), 8 deletions(-)
>
> --- linux-next-20260914.orig/Documentation/ABI/testing/debugfs-iio-backend
> +++ linux-next-20260914/Documentation/ABI/testing/debugfs-iio-backend
> @@ -8,13 +8,13 @@ What: /sys/kernel/debug/iio/iio:deviceX
> KernelVersion: 6.11
> Contact: linux-iio@vger.kernel.org
> Description:
> - Directly access the registers of backend Y. Typical usage is:
> + Directly access the registers of backend Y. Typical usage is::
>
> - Reading address 0x50
> - echo 0x50 > direct_reg_access
> - cat direct_reg_access
> + # Reading address 0x50
> + echo 0x50 > direct_reg_access
> + cat direct_reg_access
>
> - Writing address 0x50
> - echo 0x50 0x3 > direct_reg_access
> - //readback address 0x50
> - cat direct_reg_access
> + # Writing address 0x50
> + echo 0x50 0x3 > direct_reg_access
> + # readback address 0x50
> + cat direct_reg_access
next prev parent reply other threads:[~2026-09-17 8:45 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-16 18:07 [PATCH v2] docs: iio: backend: use literal block for commands Randy Dunlap
2026-09-17 6:34 ` Andy Shevchenko
2026-09-17 8:46 ` Nuno Sá [this message]
2026-09-21 0:01 ` 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=aquoqnyKi8BAVyZX@nsa \
--to=nuno.sa@analog.com \
--cc=andy@kernel.org \
--cc=corbet@lwn.net \
--cc=dlechner@baylibre.com \
--cc=jic23@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=olivier.moysan@foss.st.com \
--cc=rdunlap@infradead.org \
--cc=skhan@linuxfoundation.org \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.