Re: [PATCH] docs: iio: backend: use literal block for commands

From: Randy Dunlap

Date: Wed Sep 16 2026 - 13:24:54 EST




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