Skip to content

Commit fe11859

Browse files
rddunlapJonathan Corbet
authored andcommitted
Docs: kernel-parameters: sort the LEGEND list
Sort the list of kernel build options and hardware support options. Add a comment that the list should be kept sorted instead of having new options inserted willy nilly. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230725174247.32393-1-rdunlap@infradead.org
1 parent 87f8d8f commit fe11859

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

Documentation/admin-guide/kernel-parameters.rst

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,11 @@ reveal their parameters in /sys/module/${modulename}/parameters/. Some of these
8989
parameters may be changed at runtime by the command
9090
``echo -n ${value} > /sys/module/${modulename}/parameters/${parm}``.
9191

92-
The parameters listed below are only valid if certain kernel build options were
93-
enabled and if respective hardware is present. The text in square brackets at
94-
the beginning of each description states the restrictions within which a
95-
parameter is applicable::
92+
The parameters listed below are only valid if certain kernel build options
93+
were enabled and if respective hardware is present. This list should be kept
94+
in alphabetical order. The text in square brackets at the beginning
95+
of each description states the restrictions within which a parameter
96+
is applicable::
9697

9798
ACPI ACPI support is enabled.
9899
AGP AGP (Accelerated Graphics Port) is enabled.
@@ -127,9 +128,9 @@ parameter is applicable::
127128
KGDB Kernel debugger support is enabled.
128129
KVM Kernel Virtual Machine support is enabled.
129130
LIBATA Libata driver is enabled
130-
LP Printer support is enabled.
131131
LOONGARCH LoongArch architecture is enabled.
132132
LOOP Loopback device support is enabled.
133+
LP Printer support is enabled.
133134
M68k M68k architecture is enabled.
134135
These options have more detailed description inside of
135136
Documentation/arch/m68k/kernel-options.rst.
@@ -139,10 +140,9 @@ parameter is applicable::
139140
MSI Message Signaled Interrupts (PCI).
140141
MTD MTD (Memory Technology Device) support is enabled.
141142
NET Appropriate network support is enabled.
142-
NUMA NUMA support is enabled.
143143
NFS Appropriate NFS support is enabled.
144+
NUMA NUMA support is enabled.
144145
OF Devicetree is enabled.
145-
PV_OPS A paravirtualized kernel is enabled.
146146
PARISC The PA-RISC architecture is enabled.
147147
PCI PCI bus support is enabled.
148148
PCIE PCI Express support is enabled.
@@ -151,9 +151,10 @@ parameter is applicable::
151151
PPC PowerPC architecture is enabled.
152152
PPT Parallel port support is enabled.
153153
PS2 Appropriate PS/2 support is enabled.
154+
PV_OPS A paravirtualized kernel is enabled.
154155
RAM RAM disk support is enabled.
155-
RISCV RISCV architecture is enabled.
156156
RDT Intel Resource Director Technology.
157+
RISCV RISCV architecture is enabled.
157158
S390 S390 architecture is enabled.
158159
SCSI Appropriate SCSI support is enabled.
159160
A lot of drivers have their options described inside
@@ -164,15 +165,15 @@ parameter is applicable::
164165
SH SuperH architecture is enabled.
165166
SMP The kernel is an SMP kernel.
166167
SPARC Sparc architecture is enabled.
167-
SWSUSP Software suspend (hibernation) is enabled.
168168
SUSPEND System suspend states are enabled.
169+
SWSUSP Software suspend (hibernation) is enabled.
169170
TPM TPM drivers are enabled.
170171
UMS USB Mass Storage support is enabled.
171172
USB USB support is enabled.
172173
USBHID USB Human Interface Device support is enabled.
173174
V4L Video For Linux support is enabled.
174-
VMMIO Driver for memory mapped virtio devices is enabled.
175175
VGA The VGA console has been enabled.
176+
VMMIO Driver for memory mapped virtio devices is enabled.
176177
VT Virtual terminal support is enabled.
177178
WDT Watchdog support is enabled.
178179
X86-32 X86-32, aka i386 architecture is enabled.
@@ -186,9 +187,9 @@ parameter is applicable::
186187

187188
In addition, the following text indicates that the option::
188189

190+
BOOT Is a boot loader parameter.
189191
BUGS= Relates to possible processor bugs on the said processor.
190192
KNL Is a kernel start-up parameter.
191-
BOOT Is a boot loader parameter.
192193

193194
Parameters denoted with BOOT are actually interpreted by the boot
194195
loader, and have no meaning to the kernel directly.

0 commit comments

Comments
 (0)