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

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

Posted by Randy Dunlap 1 week, 1 day ago

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

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

Posted by Jonathan Cameron 4 days, 3 hours ago

On Wed, 16 Sep 2026 11:07:39 -0700
Randy Dunlap <rdunlap@infradead.org> 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>
Applied.  Thanks

Jonathan

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

Posted by Nuno Sá 1 week ago

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

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

Posted by Andy Shevchenko 1 week ago

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.

Reviewed-by: Andy Shevchenko <andy@kernel.org>

-- 
With Best Regards,
Andy Shevchenko