Re: [PATCH 25/25] Documentation: sysfs-block-device: document command duration limits

[Damien Le Moal]

On 12/9/22 12:22, Bagas Sanjaya wrote:
> On Thu, Dec 08, 2022 at 11:59:41AM +0100, Niklas Cassel wrote:
>> +What:		/sys/block/*/device/duration_limits/enable
>> +Date:		Dec, 2022
>> +KernelVersion:	v6.3
>> +Contact:	linux-scsi@xxxxxxxxxxxxxxx
>> +Description:
>> +		(RW) For ATA and SCSI devices supporting the command duration
>> +		limits feature, write to the file to turn on or off the
>> +		feature. By default this feature is turned off. If the device
>> +		does not support the command duration limits feature, this
>> +		attribute does not exist (the directory
>> +		"/sys/block/*/device/duration_limits" does not exist).
>> +		Writing "1" to this file enables the use of command duration
>> +		limits for read and write commands in the kernel and turns on
>> +		the feature on the device. Writing "0" disables the feature.
> 
> Sphinx reported inline emphasis warning due to unescaped asterisk above:
> 
> Documentation/ABI/testing/sysfs-block-device:101: WARNING: Inline emphasis start-string without end-string.
> 
> I have applied the fixup:

[...]

>> <snipped>...
>> +		    Possible values are:
>> +
>> +		      - 0x0: The device will complete the command at the
>> +			     earliest possible time (i.e, do nothing based on
>> +			     the time limit not being met).
>> +		      - 0xD: The device will complete the command and an IO
>> +			     failure will be reported to the user with the ETIME
>> +			     error code.
>> +		      - 0xF: Same as 0xD.
>> +
> 
> The lists items above looks poorly indented in htmldocs (due to use of
> proportional fonts). The fix is to align to first character after bullet
> list marker, like:

Thanks for the hints. Will fix that in v2.


-- 
Damien Le Moal
Western Digital Research