Linux Documentation
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: "Randy Dunlap" <rdunlap@infradead.org>,
	"Mark Pearson" <mpearson-lenovo@squebb.ca>,
	"Hans de Goede" <hansg@kernel.org>,
	"Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>,
	platform-driver-x86@vger.kernel.org,
	"Jonathan Corbet" <corbet@lwn.net>,
	"Shuah Khan" <skhan@linuxfoundation.org>,
	linux-doc@vger.kernel.org
Subject: [PATCH] docs: ABI: sysfs-class-firmware-attributes: use literal blocks for console commands
Date: Tue, 22 Sep 2026 19:49:56 -0700	[thread overview]
Message-ID: <20260923024957.845198-1-rdunlap@infradead.org> (raw)

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

             reply	other threads:[~2026-09-23  2:50 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-09-23  2:49 Randy Dunlap [this message]
2026-09-23 12:31 ` [PATCH] docs: ABI: sysfs-class-firmware-attributes: use literal blocks for console commands Mark Pearson
2026-09-26 15:47 ` Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260923024957.845198-1-rdunlap@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=corbet@lwn.net \
    --cc=hansg@kernel.org \
    --cc=ilpo.jarvinen@linux.intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mpearson-lenovo@squebb.ca \
    --cc=platform-driver-x86@vger.kernel.org \
    --cc=skhan@linuxfoundation.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox