[PATCH] docs: ABI: TMR manager: use literal blocks for console I/O

Randy Dunlap posted 1 patch 3 days, 15 hours ago
Documentation/ABI/testing/sysfs-driver-xilinx-tmr-manager |   14 +++++-----
1 file changed, 8 insertions(+), 6 deletions(-)
[PATCH] docs: ABI: TMR manager: use literal blocks for console I/O
Posted by Randy Dunlap 3 days, 15 hours ago
Use literal blocks so that the console commands and their output
are not joined together on one line.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Appana Durga Kedareswara rao <appana.durga.kedareswara.rao@amd.com>
Cc: Michal Simek <michal.simek@amd.com>
Cc: linux-arm-kernel@lists.infradead.org
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: linux-doc@vger.kernel.org

 Documentation/ABI/testing/sysfs-driver-xilinx-tmr-manager |   14 +++++-----
 1 file changed, 8 insertions(+), 6 deletions(-)

--- linux-next-20260918.orig/Documentation/ABI/testing/sysfs-driver-xilinx-tmr-manager
+++ linux-next-20260918/Documentation/ABI/testing/sysfs-driver-xilinx-tmr-manager
@@ -3,14 +3,16 @@ Date:          Nov 2022
 Contact:       appana.durga.kedareswara.rao@amd.com
 Description:   This control file provides the fault detection count.
                This file cannot be written.
-               Example:
-               # cat /sys/devices/platform/amba_pl/44a10000.tmr_manager/errcnt
-               1
+               Example::
+
+                 # cat /sys/devices/platform/amba_pl/44a10000.tmr_manager/errcnt
+                 1
 
 What:          /sys/devices/platform/amba_pl/<dev>/dis_block_break
 Date:          Nov 2022
 Contact:       appana.durga.kedareswara.rao@amd.com
-Description:   Write any value to it, This control file enables the break signal.
+Description:   Write any value to it. This control file enables the break signal.
                This file is write only.
-               Example:
-               # echo <any value> > /sys/devices/platform/amba_pl/44a10000.tmr_manager/dis_block_break
+               Example::
+
+                 # echo <any value> > /sys/devices/platform/amba_pl/44a10000.tmr_manager/dis_block_break
Re: [PATCH] docs: ABI: TMR manager: use literal blocks for console I/O
Posted by Michal Simek 3 days, 12 hours ago

On 9/21/26 06:49, Randy Dunlap wrote:
> Use literal blocks so that the console commands and their output
> are not joined together on one line.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Appana Durga Kedareswara rao <appana.durga.kedareswara.rao@amd.com>
> Cc: Michal Simek <michal.simek@amd.com>
> Cc: linux-arm-kernel@lists.infradead.org
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Shuah Khan <skhan@linuxfoundation.org>
> Cc: linux-doc@vger.kernel.org
> 
>   Documentation/ABI/testing/sysfs-driver-xilinx-tmr-manager |   14 +++++-----
>   1 file changed, 8 insertions(+), 6 deletions(-)
> 
> --- linux-next-20260918.orig/Documentation/ABI/testing/sysfs-driver-xilinx-tmr-manager
> +++ linux-next-20260918/Documentation/ABI/testing/sysfs-driver-xilinx-tmr-manager
> @@ -3,14 +3,16 @@ Date:          Nov 2022
>   Contact:       appana.durga.kedareswara.rao@amd.com
>   Description:   This control file provides the fault detection count.
>                  This file cannot be written.
> -               Example:
> -               # cat /sys/devices/platform/amba_pl/44a10000.tmr_manager/errcnt
> -               1
> +               Example::
> +
> +                 # cat /sys/devices/platform/amba_pl/44a10000.tmr_manager/errcnt
> +                 1
>   
>   What:          /sys/devices/platform/amba_pl/<dev>/dis_block_break
>   Date:          Nov 2022
>   Contact:       appana.durga.kedareswara.rao@amd.com
> -Description:   Write any value to it, This control file enables the break signal.
> +Description:   Write any value to it. This control file enables the break signal.
>                  This file is write only.
> -               Example:
> -               # echo <any value> > /sys/devices/platform/amba_pl/44a10000.tmr_manager/dis_block_break
> +               Example::
> +
> +                 # echo <any value> > /sys/devices/platform/amba_pl/44a10000.tmr_manager/dis_block_break

Reviewed-by: Michal Simek <michal.simek@amd.com>

Thanks,
Michal