[PATCH] ABI: sysfs-bus-pci: use literal blocks for commands

[PATCH] ABI: sysfs-bus-pci: use literal blocks for commands

[Randy Dunlap]

Use literal blocks for console I/O to separate it 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: Bjorn Helgaas <bhelgaas@google.com>
Cc: linux-pci@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-bus-pci |   14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

--- linux-next-20260918.orig/Documentation/ABI/testing/sysfs-bus-pci
+++ linux-next-20260918/Documentation/ABI/testing/sysfs-bus-pci
@@ -486,19 +486,19 @@ Description:
 		These files provide an interface to PCIe Resizable BAR support.
 		A file is created for each BAR resource (N) supported by the
 		PCIe Resizable BAR extended capability of the device.  Reading
-		each file exposes the bitmap of available resource sizes:
+		each file exposes the bitmap of available resource sizes::
 
-		# cat resource1_resize
-		00000000000001c0
+		  # cat resource1_resize
+		  00000000000001c0
 
 		The bitmap represents supported resource sizes for the BAR,
 		where bit0 = 1MB, bit1 = 2MB, bit2 = 4MB, etc.  In the above
 		example the device supports 64MB, 128MB, and 256MB BAR sizes.
 
 		When writing the file, the user provides the bit position of
-		the desired resource size, for example:
+		the desired resource size, for example::
 
-		# echo 7 > resource1_resize
+		  # echo 7 > resource1_resize
 
 		This indicates to set the size value corresponding to bit 7,
 		128MB.  The resulting size is 2 ^ (bit# + 20).  This definition
@@ -600,7 +600,7 @@ Description:
 
 		As all DOE devices must support the DOE discovery feature,
 		if DOE is supported you will at least see the doe_discovery
-		file, with this contents:
+		file, with this contents::
 
 		  # cat doe_features/doe_discovery
 		  0001:00
@@ -608,7 +608,7 @@ Description:
 		If the device supports other features you will see other
 		files as well. For example if CMA/SPDM and secure CMA/SPDM
 		are supported the doe_features directory will look like
-		this:
+		this::
 
 		  # ls doe_features
 		  0001:01        0001:02        doe_discovery

Re: [PATCH] ABI: sysfs-bus-pci: use literal blocks for commands

[Jonathan Corbet]

Randy Dunlap <rdunlap@infradead.org> writes:

> Use literal blocks for console I/O to separate it 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: Bjorn Helgaas <bhelgaas@google.com>
> Cc: linux-pci@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-bus-pci |   14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)

Applied, thanks.

jon