Commit d2fc83c1 authored by Randy Dunlap's avatar Randy Dunlap Committed by Jonathan Corbet
Browse files

Docs/admin: alphabetize some kernel-parameters (part 1) 



Move some out-of-place kernel parameters into their correct
locations.

Move one out-of-order keyword/legend in kernel-parameters.rst.

Add some missing keyword legends in kernel-parameters.rst:
  HIBERNATION HYPER_V
and drop some obsolete/removed keyword legends:
 EIDE IOSCHED OSS TS XT

Correct the location of the setup.h file.

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: "Rafael J. Wysocki" <rafael@kernel.org>
Cc: Pavel Machek <pavel@ucw.cz>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 59bdbbd5

Documentation/admin-guide/kernel-parameters.rst

+4 −7
Original line number Diff line number Diff line
@@ -99,6 +99,7 @@ parameter is applicable:: 
	ALSA	ALSA sound support is enabled.

	APIC	APIC support is enabled.

	APM	Advanced Power Management support is enabled.

	APPARMOR AppArmor support is enabled.

	ARM	ARM architecture is enabled.

	ARM64	ARM64 architecture is enabled.

	AX25	Appropriate AX.25 support is enabled.
@@ -108,15 +109,15 @@ parameter is applicable:: 
	DYNAMIC_DEBUG Build in debug messages and enable them at runtime

	EDD	BIOS Enhanced Disk Drive Services (EDD) is enabled

	EFI	EFI Partitioning (GPT) is enabled

	EIDE	EIDE/ATAPI support is enabled.

	EVM	Extended Verification Module

	FB	The frame buffer device is enabled.

	FTRACE	Function tracing enabled.

	GCOV	GCOV profiling is enabled.

	HIBERNATION HIBERNATION is enabled.

	HW	Appropriate hardware is enabled.

	HYPER_V HYPERV support is enabled.

	IA-64	IA-64 architecture is enabled.

	IMA     Integrity measurement architecture is enabled.

	IOSCHED	More than one I/O scheduler is enabled.

	IP_PNP	IP DHCP, BOOTP, or RARP is enabled.

	IPV6	IPv6 support is enabled.

	ISAPNP	ISA PnP code is enabled.
@@ -140,7 +141,6 @@ parameter is applicable:: 
	NUMA	NUMA support is enabled.

	NFS	Appropriate NFS support is enabled.

	OF	Devicetree is enabled.

	OSS	OSS sound support is enabled.

	PV_OPS	A paravirtualized kernel is enabled.

	PARIDE	The ParIDE (parallel port IDE) subsystem is enabled.

	PARISC	The PA-RISC architecture is enabled.
@@ -160,7 +160,6 @@ parameter is applicable:: 
			the Documentation/scsi/ sub-directory.

	SECURITY Different security models are enabled.

	SELINUX SELinux support is enabled.

	APPARMOR AppArmor support is enabled.

	SERIAL	Serial support is enabled.

	SH	SuperH architecture is enabled.

	SMP	The kernel is an SMP kernel.
@@ -168,7 +167,6 @@ parameter is applicable:: 
	SWSUSP	Software suspend (hibernation) is enabled.

	SUSPEND	System suspend states are enabled.

	TPM	TPM drivers are enabled.

	TS	Appropriate touchscreen support is enabled.

	UMS	USB Mass Storage support is enabled.

	USB	USB support is enabled.

	USBHID	USB Human Interface Device support is enabled.
@@ -177,7 +175,6 @@ parameter is applicable:: 
	VGA	The VGA console has been enabled.

	VT	Virtual terminal support is enabled.

	WDT	Watchdog support is enabled.

	XT	IBM PC/XT MFM hard disk support is enabled.

	X86-32	X86-32, aka i386 architecture is enabled.

	X86-64	X86-64 architecture is enabled.

			More X86-64 boot options can be found in
@@ -211,7 +208,7 @@ The number of kernel parameters is not limited, but the length of the 
complete command line (parameters including spaces etc.) is limited to

a fixed number of characters. This limit depends on the architecture

and is between 256 and 4096 characters. It is defined in the file

./include/asm/setup.h as COMMAND_LINE_SIZE.

./include/uapi/asm-generic/setup.h as COMMAND_LINE_SIZE.



Finally, the [KMG] suffix is commonly described after a number of kernel

parameter values. These 'K', 'M', and 'G' letters represent the _binary_

Documentation/admin-guide/kernel-parameters.txt

+57 −56
Original line number Diff line number Diff line
@@ -563,6 +563,20 @@ 


	cio_ignore=	[S390]

			See Documentation/s390/common_io.rst for details.



	clearcpuid=BITNUM[,BITNUM...] [X86]

			Disable CPUID feature X for the kernel. See

			arch/x86/include/asm/cpufeatures.h for the valid bit

			numbers. Note the Linux specific bits are not necessarily

			stable over kernel options, but the vendor specific

			ones should be.

			Also note that user programs calling CPUID directly

			or using the feature without checking anything

			will still see it. This just prevents it from

			being used by the kernel or shown in /proc/cpuinfo.

			Also note the kernel might malfunction if you disable

			some critical bits.



	clk_ignore_unused

			[CLK]

			Prevents the clock framework from automatically gating
@@ -631,19 +645,6 @@ 
			Defaults to zero when built as a module and to

			10 seconds when built into the kernel.



	clearcpuid=BITNUM[,BITNUM...] [X86]

			Disable CPUID feature X for the kernel. See

			arch/x86/include/asm/cpufeatures.h for the valid bit

			numbers. Note the Linux specific bits are not necessarily

			stable over kernel options, but the vendor specific

			ones should be.

			Also note that user programs calling CPUID directly

			or using the feature without checking anything

			will still see it. This just prevents it from

			being used by the kernel or shown in /proc/cpuinfo.

			Also note the kernel might malfunction if you disable

			some critical bits.



	cma=nn[MG]@[start[MG][-end[MG]]]

			[KNL,CMA]

			Sets the size of kernel global memory area for
@@ -950,6 +951,8 @@ 
			dump out devices still on the deferred probe list after

			retrying.



	delayacct	[KNL] Enable per-task delay accounting



	dell_smm_hwmon.ignore_dmi=

			[HW] Continue probing hardware even if DMI data

			indicates that the driver is running on unsupported
@@ -1003,17 +1006,6 @@ 
	disable=	[IPV6]

			See Documentation/networking/ipv6.rst.



	hardened_usercopy=

                        [KNL] Under CONFIG_HARDENED_USERCOPY, whether

                        hardening is enabled for this boot. Hardened

                        usercopy checking is used to protect the kernel

                        from reading or writing beyond known memory

                        allocation boundaries as a proactive defense

                        against bounds-checking flaws in the kernel's

                        copy_to_user()/copy_from_user() interface.

                on      Perform hardened usercopy checks (default).

                off     Disable hardened usercopy checks.



	disable_radix	[PPC]

			Disable RADIX MMU mode on POWER9
@@ -1316,17 +1308,6 @@ 
			force: enforce the use of EDAC to report H/W event.

			default: on.



	ekgdboc=	[X86,KGDB] Allow early kernel console debugging

			ekgdboc=kbd



			This is designed to be used in conjunction with

			the boot argument: earlyprintk=vga



			This parameter works in place of the kgdboc parameter

			but can only be used if the backing tty is available

			very early in the boot process. For early debugging

			via a serial port see kgdboc_earlycon instead.



	edd=		[EDD]

			Format: {"off" | "on" | "skip[mbr]"}
@@ -1388,6 +1369,17 @@ 
	eisa_irq_edge=	[PARISC,HW]

			See header of drivers/parisc/eisa.c.



	ekgdboc=	[X86,KGDB] Allow early kernel console debugging

			Format: ekgdboc=kbd



			This is designed to be used in conjunction with

			the boot argument: earlyprintk=vga



			This parameter works in place of the kgdboc parameter

			but can only be used if the backing tty is available

			very early in the boot process. For early debugging

			via a serial port see kgdboc_earlycon instead.



	elanfreq=	[X86-32]

			See comment before function elanfreq_setup() in

			arch/x86/kernel/cpu/cpufreq/elanfreq.c.
@@ -1586,6 +1578,17 @@ 
			Format: <unsigned int> such that (rxsize & ~0x1fffc0) == 0.

			Default: 1024



	hardened_usercopy=

			[KNL] Under CONFIG_HARDENED_USERCOPY, whether

			hardening is enabled for this boot. Hardened

			usercopy checking is used to protect the kernel

			from reading or writing beyond known memory

			allocation boundaries as a proactive defense

			against bounds-checking flaws in the kernel's

			copy_to_user()/copy_from_user() interface.

		on	Perform hardened usercopy checks (default).

		off	Disable hardened usercopy checks.



	hardlockup_all_cpu_backtrace=

			[KNL] Should the hard-lockup detector generate

			backtraces on all cpus.
@@ -1606,6 +1609,15 @@ 
			corresponding firmware-first mode error processing

			logic will be disabled.



	hibernate=	[HIBERNATION]

		noresume	Don't check if there's a hibernation image

				present during boot.

		nocompress	Don't compress/decompress hibernation images.

		no		Disable hibernation and resume.

		protect_image	Turn on image protection during restoration

				(that will set all pages holding image data

				during restoration read-only).



	highmem=nn[KMG]	[KNL,BOOT] forces the highmem zone to have an exact

			size of <nn>. This works even on boxes that have no

			highmem otherwise. This also works to reduce highmem
@@ -3185,16 +3197,6 @@ 
			firmware feature for updating multiple TCE entries

			at a time.



	onenand.bdry=	[HW,MTD] Flex-OneNAND Boundary Configuration



			Format: [die0_boundary][,die0_lock][,die1_boundary][,die1_lock]



			boundary - index of last SLC block on Flex-OneNAND.

				   The remaining blocks are configured as MLC blocks.

			lock	 - Configure if Flex-OneNAND boundary should be locked.

				   Once locked, the boundary cannot be changed.

				   1 indicates lock status, 0 indicates unlock status.



	mtdset=		[ARM]

			ARM/S3C2412 JIVE boot control
@@ -3441,8 +3443,6 @@ 


	noclflush	[BUGS=X86] Don't use the CLFLUSH instruction



	delayacct	[KNL] Enable per-task delay accounting



	nodsp		[SH] Disable hardware DSP at boot time.



	noefi		Disable EFI runtime services support.
@@ -3744,6 +3744,16 @@ 
			For example, to override I2C bus2:

			omap_mux=i2c2_scl.i2c2_scl=0x100,i2c2_sda.i2c2_sda=0x100



	onenand.bdry=	[HW,MTD] Flex-OneNAND Boundary Configuration



			Format: [die0_boundary][,die0_lock][,die1_boundary][,die1_lock]



			boundary - index of last SLC block on Flex-OneNAND.

				   The remaining blocks are configured as MLC blocks.

			lock	 - Configure if Flex-OneNAND boundary should be locked.

				   Once locked, the boundary cannot be changed.

				   1 indicates lock status, 0 indicates unlock status.



	oops=panic	Always panic on oopses. Default is to just kill the

			process, but there is a small probability of

			deadlocking the machine.
@@ -5077,15 +5087,6 @@ 
			Useful for devices that are detected asynchronously

			(e.g. USB and MMC devices).



	hibernate=	[HIBERNATION]

		noresume	Don't check if there's a hibernation image

				present during boot.

		nocompress	Don't compress/decompress hibernation images.

		no		Disable hibernation and resume.

		protect_image	Turn on image protection during restoration

				(that will set all pages holding image data

				during restoration read-only).



	retain_initrd	[RAM] Keep initrd memory after extraction



	rfkill.default_state=