Documentation/ABI/testing/debugfs-iio-backend | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)
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.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
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
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 -- With Best Regards, Andy Shevchenko
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
© 2016 - 2026 Red Hat, Inc.