Re: [PATCH] firmware: zynqmp: use literal blocks for commands

[Randy Dunlap <rdunlap@infradead.org>]

On 9/15/26 11:56 AM, Jonathan Corbet wrote:
> Randy Dunlap <rdunlap@infradead.org> writes:
> 
>> 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: Michal Simek <michal.simek@amd.com>
>> Cc: Ronak Jain <ronak.jain@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/stable/sysfs-driver-firmware-zynqmp |   70 +++++++---
>>  1 file changed, 50 insertions(+), 20 deletions(-)
>>
>> --- linux-next-20260911.orig/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
>> +++ linux-next-20260911/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
>> @@ -141,32 +141,44 @@ Description:
>>  
>>  		Usage:
>>  
>> -		Select over temperature config ID to enable/disable feature
>> +		Select over temperature config ID to enable/disable feature::
>> +
>>  		# echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
> 
> I was sure that this wouldn't work, since the literal block is not
> indented relative to the containing text.  Sphinx does the right thing,
> though... so applied, thanks,

Yeah, I did test it and looked at the output. :)

-- 
~Randy