From: Randy Dunlap <rdunlap@infradead.org>
To: Andy Shevchenko <andriy.shevchenko@intel.com>
Cc: linux-kernel@vger.kernel.org, Nuno Sa <nuno.sa@analog.com>,
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] docs: iio: backend: use literal block for commands
Date: Wed, 16 Sep 2026 10:07:59 -0700 [thread overview]
Message-ID: <4a7ff403-d223-41ba-bc4a-cd73680fff37@infradead.org> (raw)
In-Reply-To: <aqpFtj_yYBcznhDT@ashevche-desk.local>
On 9/16/26 12:31 AM, Andy Shevchenko wrote:
> On Tue, Sep 15, 2026 at 10:49:24PM -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.
>
> ...
>
>> - 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
>
> Then make it a shell comment style
>
> # 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
>
> Ditto.
>
>> + echo 0x50 0x3 > direct_reg_access
>> + //readback address 0x50
>
> And correct the style of this altogether.
>
>> + cat direct_reg_access
>
Agreed; will do.
--
~Randy
prev parent reply other threads:[~2026-09-16 17:08 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-16 5:49 Randy Dunlap
2026-09-16 7:31 ` Andy Shevchenko
2026-09-16 17:07 ` Randy Dunlap [this message]
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=4a7ff403-d223-41ba-bc4a-cd73680fff37@infradead.org \
--to=rdunlap@infradead.org \
--cc=andriy.shevchenko@intel.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=nuno.sa@analog.com \
--cc=olivier.moysan@foss.st.com \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®