Re: [PATCH 1/2] Documentation: Merge x86-specific boot options doc into kernel-parameters.txt

[Sohil Mehta <sohil.mehta@intel.com>]

On 11/20/2024 1:11 PM, Borislav Petkov wrote:
> On Wed, Nov 20, 2024 at 12:49:10PM -0800, Sohil Mehta wrote:
>> Instead of double tabs and <option>: <description>, would this be more
>> readable if the options and their descriptions are separated?
> 
> Have you seen the rest of this file?
> 

To clarify, I am not suggesting to have the description at less than 2
tab distance from the main command line option. It's just the
sub-option. It would still keep everything aligned with the rest of the
file.

	mce=
		<sub-option-1>
			[Description - ...]

		<sub-option-2>
			[Description - ...]


I see quite a few places that do exactly as the above:
 console=
 console_msg_format=
 earlycon=
 hibernate=
 intel_iommu=
 io_delay=
 pcie_*=


In some other cases such as pci=, mitigations=, spectre_v2_user= and
vsyscall= the sub-option is at a 1-2 tab distance and the description is
another 1-2 tabs from that.

Either way, in most places, I see the sub-option and description being
separated which is all I am requesting. (Pretty please?)

efi= and idle= has it similar to the way you have proposed for mce= but
I find it harder to read. (Maybe it's just me.)