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

From: Nuno Sá

Date: Thu Sep 17 2026 - 04:46:19 EST


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@xxxxxxxxxxxxx>
> ---

Reviewed-by: Nuno Sá <nuno.sa@xxxxxxxxxx>

> v2: use shell comment style (Andy)
>
> Cc: Nuno Sa <nuno.sa@xxxxxxxxxx>
> Cc: Olivier Moysan <olivier.moysan@xxxxxxxxxxx>
> Cc: Jonathan Cameron <jic23@xxxxxxxxxx>
> Cc: David Lechner <dlechner@xxxxxxxxxxxx>
> Cc: Andy Shevchenko <andy@xxxxxxxxxx>
> Cc: linux-iio@xxxxxxxxxxxxxxx
> Cc: Jonathan Corbet <corbet@xxxxxxx>
> Cc: Shuah Khan <skhan@xxxxxxxxxxxxxxxxxxx>
> Cc: linux-doc@xxxxxxxxxxxxxxx
>
> 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@xxxxxxxxxxxxxxx
> 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