[PATCH] docs: ABI: sysfs-class-firmware-attributes: use literal blocks for console commands

[PATCH] docs: ABI: sysfs-class-firmware-attributes: use literal blocks for console commands

[Randy Dunlap]

Use a literal block for console I/O so that the lines aren't merged
together in the produced output.

Also correct some punctuation.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Mark Pearson <mpearson-lenovo@squebb.ca>
Cc: Hans de Goede <hansg@kernel.org>
Cc: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Cc: platform-driver-x86@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: linux-doc@vger.kernel.org

 Documentation/ABI/testing/sysfs-class-firmware-attributes |   21 +++++-----
 1 file changed, 12 insertions(+), 9 deletions(-)

--- linux-next-20260921.orig/Documentation/ABI/testing/sysfs-class-firmware-attributes
+++ linux-next-20260921/Documentation/ABI/testing/sysfs-class-firmware-attributes
@@ -397,22 +397,25 @@ Description:
 		unlimited attributes.
 
 		Read the attribute to check what save mode is enabled (single or bulk).
-		E.g:
-		# cat /sys/class/firmware-attributes/thinklmi/attributes/save_settings
-		single
+		E.g::
+
+		  # cat /sys/class/firmware-attributes/thinklmi/attributes/save_settings
+		  single
 
 		Write the attribute with 'bulk' to enable bulk save mode.
-		Write the attribute with 'single' to enable saving, after every attribute set.
+		Write the attribute with 'single' to enable saving after every attribute set.
 		The default setting is single mode.
-		E.g:
-		# echo bulk > /sys/class/firmware-attributes/thinklmi/attributes/save_settings
+		E.g::
+
+		  # echo bulk > /sys/class/firmware-attributes/thinklmi/attributes/save_settings
 
 		When in bulk mode write 'save' to trigger a save of all currently modified attributes.
-		Note, once a save has been triggered, in bulk mode, attributes can no longer be set and
+		Note, once a save has been triggered in bulk mode, attributes can no longer be set and
 		will return a permissions error. This is to prevent users hitting the 48+ save limitation
 		(which requires entering the BIOS to clear the error condition)
-		E.g:
-		# echo save > /sys/class/firmware-attributes/thinklmi/attributes/save_settings
+		E.g::
+
+		  # echo save > /sys/class/firmware-attributes/thinklmi/attributes/save_settings
 
 What:		/sys/class/firmware-attributes/*/attributes/debug_cmd
 Date:		July 2021

Re: [PATCH] docs: ABI: sysfs-class-firmware-attributes: use literal blocks for console commands

[Mark Pearson]

On Tue, Sep 22, 2026, at 10:49 PM, Randy Dunlap wrote:
> Use a literal block for console I/O so that the lines aren't merged
> together in the produced output.
>
> Also correct some punctuation.
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Mark Pearson <mpearson-lenovo@squebb.ca>
> Cc: Hans de Goede <hansg@kernel.org>
> Cc: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
> Cc: platform-driver-x86@vger.kernel.org
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Shuah Khan <skhan@linuxfoundation.org>
> Cc: linux-doc@vger.kernel.org
>
>  Documentation/ABI/testing/sysfs-class-firmware-attributes |   21 +++++-----
>  1 file changed, 12 insertions(+), 9 deletions(-)
>
> --- 
> linux-next-20260921.orig/Documentation/ABI/testing/sysfs-class-firmware-attributes
> +++ 
> linux-next-20260921/Documentation/ABI/testing/sysfs-class-firmware-attributes
> @@ -397,22 +397,25 @@ Description:
>  		unlimited attributes.
> 
>  		Read the attribute to check what save mode is enabled (single or bulk).
> -		E.g:
> -		# cat /sys/class/firmware-attributes/thinklmi/attributes/save_settings
> -		single
> +		E.g::
> +
> +		  # cat /sys/class/firmware-attributes/thinklmi/attributes/save_settings
> +		  single
> 
>  		Write the attribute with 'bulk' to enable bulk save mode.
> -		Write the attribute with 'single' to enable saving, after every 
> attribute set.
> +		Write the attribute with 'single' to enable saving after every 
> attribute set.
>  		The default setting is single mode.
> -		E.g:
> -		# echo bulk > 
> /sys/class/firmware-attributes/thinklmi/attributes/save_settings
> +		E.g::
> +
> +		  # echo bulk > 
> /sys/class/firmware-attributes/thinklmi/attributes/save_settings
> 
>  		When in bulk mode write 'save' to trigger a save of all currently 
> modified attributes.
> -		Note, once a save has been triggered, in bulk mode, attributes can 
> no longer be set and
> +		Note, once a save has been triggered in bulk mode, attributes can no 
> longer be set and
>  		will return a permissions error. This is to prevent users hitting 
> the 48+ save limitation
>  		(which requires entering the BIOS to clear the error condition)
> -		E.g:
> -		# echo save > 
> /sys/class/firmware-attributes/thinklmi/attributes/save_settings
> +		E.g::
> +
> +		  # echo save > 
> /sys/class/firmware-attributes/thinklmi/attributes/save_settings
> 
>  What:		/sys/class/firmware-attributes/*/attributes/debug_cmd
>  Date:		July 2021

Looks good to me
Reviewed-by: Mark Pearson <mpearson-lenovo@squebb.ca>

Mark

Re: [PATCH] docs: ABI: sysfs-class-firmware-attributes: use literal blocks for console commands

[Jonathan Corbet]

Randy Dunlap <rdunlap@infradead.org> writes:

> Use a literal block for console I/O so that the lines aren't merged
> together in the produced output.
>
> Also correct some punctuation.
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Mark Pearson <mpearson-lenovo@squebb.ca>
> Cc: Hans de Goede <hansg@kernel.org>
> Cc: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
> Cc: platform-driver-x86@vger.kernel.org
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Shuah Khan <skhan@linuxfoundation.org>
> Cc: linux-doc@vger.kernel.org
>
>  Documentation/ABI/testing/sysfs-class-firmware-attributes |   21 +++++-----
>  1 file changed, 12 insertions(+), 9 deletions(-)

Applied, thanks.

jon