diff mbox series

Docs: admin/kernel-parameters: edit a few boot options

Message ID 20220321012216.23724-1-rdunlap@infradead.org
State Superseded
Headers show
Series Docs: admin/kernel-parameters: edit a few boot options | expand

Commit Message

Randy Dunlap March 21, 2022, 1:22 a.m. UTC
Clean up some of admin-guide/kernel-parameters.txt:

a. "smt" should be "smt=" (S390)
b. add "smt-enabled" for POWERPC
c. Sparc supports the vdso= boot option
d. make the tp_printk options (2) formatting similar to other options
   by adding spacing
e. add "trace_clock=" with a reference to Documentation/trace/ftrace.rst
f. use [IA-64] as documented instead of [ia64]
g. fix formatting and text for test_suspend=
h. fix formatting for swapaccount=
i. fix formatting and grammar for video.brightness_switch_enabled=

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Heiko Carstens <hca@linux.ibm.com>
Cc: Vasily Gorbik <gor@linux.ibm.com>
Cc: Alexander Gordeev <agordeev@linux.ibm.com>
Cc: Christian Borntraeger <borntraeger@linux.ibm.com>
Cc: Sven Schnelle <svens@linux.ibm.com>
Cc: linux-s390@vger.kernel.org
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: sparclinux@vger.kernel.org
Cc: Michael Ellerman <mpe@ellerman.id.au>
Cc: Benjamin Herrenschmidt <benh@kernel.crashing.org>
Cc: Paul Mackerras <paulus@samba.org>
Cc: linuxppc-dev@lists.ozlabs.org
Cc: linux-ia64@vger.kernel.org
Cc: "Rafael J. Wysocki" <rafael@kernel.org>
Cc: Pavel Machek <pavel@ucw.cz>
Cc: Len Brown <lenb@kernel.org>
Cc: linux-pm@vger.kernel.org
Cc: linux-acpi@vger.kernel.org
Cc: Johannes Weiner <hannes@cmpxchg.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
---
 Documentation/admin-guide/kernel-parameters.txt |   33 +++++++++-----
 1 file changed, 22 insertions(+), 11 deletions(-)

Comments

Michael Ellerman March 22, 2022, 12:45 a.m. UTC | #1
Randy Dunlap <rdunlap@infradead.org> writes:
> Clean up some of admin-guide/kernel-parameters.txt:
>
> a. "smt" should be "smt=" (S390)
> b. add "smt-enabled" for POWERPC

I'd rather you didn't. It's not well tested and we ignore it entirely on
some platforms because it causes bugs. Eventually I'd like to remove it.

If we ever get time we'd want to support the generic `nosmt` argument
instead.

cheers
Randy Dunlap March 22, 2022, 1:41 a.m. UTC | #2
On 3/21/22 17:45, Michael Ellerman wrote:
> Randy Dunlap <rdunlap@infradead.org> writes:
>> Clean up some of admin-guide/kernel-parameters.txt:
>>
>> a. "smt" should be "smt=" (S390)
>> b. add "smt-enabled" for POWERPC
> 
> I'd rather you didn't. It's not well tested and we ignore it entirely on
> some platforms because it causes bugs. Eventually I'd like to remove it.
> 
> If we ever get time we'd want to support the generic `nosmt` argument
> instead.

No problem. Thanks for replying.
Rafael J. Wysocki March 22, 2022, 5:41 p.m. UTC | #3
On Mon, Mar 21, 2022 at 2:22 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> Clean up some of admin-guide/kernel-parameters.txt:
>
> a. "smt" should be "smt=" (S390)
> b. add "smt-enabled" for POWERPC
> c. Sparc supports the vdso= boot option
> d. make the tp_printk options (2) formatting similar to other options
>    by adding spacing
> e. add "trace_clock=" with a reference to Documentation/trace/ftrace.rst
> f. use [IA-64] as documented instead of [ia64]
> g. fix formatting and text for test_suspend=

This ->

> h. fix formatting for swapaccount=
> i. fix formatting and grammar for video.brightness_switch_enabled=

-> and the last one are fine with me, but I suppose that there will be a v2?

> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Heiko Carstens <hca@linux.ibm.com>
> Cc: Vasily Gorbik <gor@linux.ibm.com>
> Cc: Alexander Gordeev <agordeev@linux.ibm.com>
> Cc: Christian Borntraeger <borntraeger@linux.ibm.com>
> Cc: Sven Schnelle <svens@linux.ibm.com>
> Cc: linux-s390@vger.kernel.org
> Cc: Steven Rostedt <rostedt@goodmis.org>
> Cc: Ingo Molnar <mingo@redhat.com>
> Cc: "David S. Miller" <davem@davemloft.net>
> Cc: sparclinux@vger.kernel.org
> Cc: Michael Ellerman <mpe@ellerman.id.au>
> Cc: Benjamin Herrenschmidt <benh@kernel.crashing.org>
> Cc: Paul Mackerras <paulus@samba.org>
> Cc: linuxppc-dev@lists.ozlabs.org
> Cc: linux-ia64@vger.kernel.org
> Cc: "Rafael J. Wysocki" <rafael@kernel.org>
> Cc: Pavel Machek <pavel@ucw.cz>
> Cc: Len Brown <lenb@kernel.org>
> Cc: linux-pm@vger.kernel.org
> Cc: linux-acpi@vger.kernel.org
> Cc: Johannes Weiner <hannes@cmpxchg.org>
> Cc: Andrew Morton <akpm@linux-foundation.org>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> ---
>  Documentation/admin-guide/kernel-parameters.txt |   33 +++++++++-----
>  1 file changed, 22 insertions(+), 11 deletions(-)
>
> --- linux-next-20220318.orig/Documentation/admin-guide/kernel-parameters.txt
> +++ linux-next-20220318/Documentation/admin-guide/kernel-parameters.txt
> @@ -2814,7 +2814,7 @@
>                         different yeeloong laptops.
>                         Example: machtype=lemote-yeeloong-2f-7inch
>
> -       max_addr=nn[KMG]        [KNL,BOOT,ia64] All physical memory greater
> +       max_addr=nn[KMG]        [KNL,BOOT,IA-64] All physical memory greater
>                         than or equal to this physical address is ignored.
>
>         maxcpus=        [SMP] Maximum number of processors that an SMP kernel
> @@ -3057,7 +3057,7 @@
>
>         mga=            [HW,DRM]
>
> -       min_addr=nn[KMG]        [KNL,BOOT,ia64] All physical memory below this
> +       min_addr=nn[KMG]        [KNL,BOOT,IA-64] All physical memory below this
>                         physical address is ignored.
>
>         mini2440=       [ARM,HW,KNL]
> @@ -5382,13 +5382,19 @@
>                                 1: Fast pin select (default)
>                                 2: ATC IRMode
>
> -       smt             [KNL,S390] Set the maximum number of threads (logical
> +       smt=            [KNL,S390] Set the maximum number of threads (logical
>                         CPUs) to use per physical CPU on systems capable of
>                         symmetric multithreading (SMT). Will be capped to the
>                         actual hardware limit.
>                         Format: <integer>
>                         Default: -1 (no limit)
>
> +       smt-enabled=    [PPC 64-bit] Enable SMT, disable SMT, or set the
> +                       maximum number of threads. This can be used to override
> +                       the Open Firmware (OF) option.
> +                       Format: on | off | <integer>
> +                       Default: all threads enabled
> +
>         softlockup_panic=
>                         [KNL] Should the soft-lockup detector generate panics.
>                         Format: 0 | 1
> @@ -5768,8 +5774,9 @@
>                         This parameter controls use of the Protected
>                         Execution Facility on pSeries.
>
> -       swapaccount=[0|1]
> -                       [KNL] Enable accounting of swap in memory resource
> +       swapaccount=    [KNL]
> +                       Format: [0|1]
> +                       Enable accounting of swap in memory resource
>                         controller if no parameter or 1 is given or disable
>                         it if 0 is given (See Documentation/admin-guide/cgroup-v1/memory.rst)
>
> @@ -5815,7 +5822,8 @@
>
>         tdfx=           [HW,DRM]
>
> -       test_suspend=   [SUSPEND][,N]
> +       test_suspend=   [SUSPEND]
> +                       Format: { "mem" | "standby" | "freeze" }[,N]
>                         Specify "mem" (for Suspend-to-RAM) or "standby" (for
>                         standby suspend) or "freeze" (for suspend type freeze)
>                         as the system sleep state during system startup with
> @@ -5902,6 +5910,8 @@
>         trace_buf_size=nn[KMG]
>                         [FTRACE] will set tracing buffer size on each cpu.
>
> +       trace_clock=    [FTRACE] See Documentation/trace/ftrace.rst
> +
>         trace_event=[event-list]
>                         [FTRACE] Set and start specified trace events in order
>                         to facilitate early boot debugging. The event-list is a
> @@ -5924,7 +5934,7 @@
>                         See also Documentation/trace/ftrace.rst "trace options"
>                         section.
>
> -       tp_printk[FTRACE]
> +       tp_printk       [FTRACE]
>                         Have the tracepoints sent to printk as well as the
>                         tracing ring buffer. This is useful for early boot up
>                         where the system hangs or reboots and does not give the
> @@ -5946,7 +5956,7 @@
>                         frequency tracepoints such as irq or sched, can cause
>                         the system to live lock.
>
> -       tp_printk_stop_on_boot[FTRACE]
> +       tp_printk_stop_on_boot [FTRACE]
>                         When tp_printk (above) is set, it can cause a lot of noise
>                         on the console. It may be useful to only include the
>                         printing of events during boot up, as user space may
> @@ -6295,7 +6305,7 @@
>                                         HIGHMEM regardless of setting
>                                         of CONFIG_HIGHPTE.
>
> -       vdso=           [X86,SH]
> +       vdso=           [X86,SH,SPARC]
>                         On X86_32, this is an alias for vdso32=.  Otherwise:
>
>                         vdso=1: enable VDSO (the default)
> @@ -6321,11 +6331,12 @@
>         video=          [FB] Frame buffer configuration
>                         See Documentation/fb/modedb.rst.
>
> -       video.brightness_switch_enabled= [0,1]
> +       video.brightness_switch_enabled= [ACPI]
> +                       Format: [0|1]
>                         If set to 1, on receiving an ACPI notify event
>                         generated by hotkey, video driver will adjust brightness
>                         level and then send out the event to user space through
> -                       the allocated input device; If set to 0, video driver
> +                       the allocated input device. If set to 0, video driver
>                         will only send out the event without touching backlight
>                         brightness level.
>                         default: 1
Randy Dunlap March 22, 2022, 7:36 p.m. UTC | #4
On 3/22/22 10:41, Rafael J. Wysocki wrote:
> On Mon, Mar 21, 2022 at 2:22 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>> Clean up some of admin-guide/kernel-parameters.txt:
>>
>> a. "smt" should be "smt=" (S390)
>> b. add "smt-enabled" for POWERPC
>> c. Sparc supports the vdso= boot option
>> d. make the tp_printk options (2) formatting similar to other options
>>    by adding spacing
>> e. add "trace_clock=" with a reference to Documentation/trace/ftrace.rst
>> f. use [IA-64] as documented instead of [ia64]
>> g. fix formatting and text for test_suspend=
> This ->
> 
>> h. fix formatting for swapaccount=
>> i. fix formatting and grammar for video.brightness_switch_enabled=
> -> and the last one are fine with me, but I suppose that there will be a v2?

Yes, there will be a v2.

thanks.
diff mbox series

Patch

--- linux-next-20220318.orig/Documentation/admin-guide/kernel-parameters.txt
+++ linux-next-20220318/Documentation/admin-guide/kernel-parameters.txt
@@ -2814,7 +2814,7 @@ 
 			different yeeloong laptops.
 			Example: machtype=lemote-yeeloong-2f-7inch
 
-	max_addr=nn[KMG]	[KNL,BOOT,ia64] All physical memory greater
+	max_addr=nn[KMG]	[KNL,BOOT,IA-64] All physical memory greater
 			than or equal to this physical address is ignored.
 
 	maxcpus=	[SMP] Maximum number of processors that	an SMP kernel
@@ -3057,7 +3057,7 @@ 
 
 	mga=		[HW,DRM]
 
-	min_addr=nn[KMG]	[KNL,BOOT,ia64] All physical memory below this
+	min_addr=nn[KMG]	[KNL,BOOT,IA-64] All physical memory below this
 			physical address is ignored.
 
 	mini2440=	[ARM,HW,KNL]
@@ -5382,13 +5382,19 @@ 
 				1: Fast pin select (default)
 				2: ATC IRMode
 
-	smt		[KNL,S390] Set the maximum number of threads (logical
+	smt=		[KNL,S390] Set the maximum number of threads (logical
 			CPUs) to use per physical CPU on systems capable of
 			symmetric multithreading (SMT). Will be capped to the
 			actual hardware limit.
 			Format: <integer>
 			Default: -1 (no limit)
 
+	smt-enabled=	[PPC 64-bit] Enable SMT, disable SMT, or set the
+			maximum number of threads. This can be used to override
+			the Open Firmware (OF) option.
+			Format: on | off | <integer>
+			Default: all threads enabled
+
 	softlockup_panic=
 			[KNL] Should the soft-lockup detector generate panics.
 			Format: 0 | 1
@@ -5768,8 +5774,9 @@ 
 			This parameter controls use of the Protected
 			Execution Facility on pSeries.
 
-	swapaccount=[0|1]
-			[KNL] Enable accounting of swap in memory resource
+	swapaccount=	[KNL]
+			Format: [0|1]
+			Enable accounting of swap in memory resource
 			controller if no parameter or 1 is given or disable
 			it if 0 is given (See Documentation/admin-guide/cgroup-v1/memory.rst)
 
@@ -5815,7 +5822,8 @@ 
 
 	tdfx=		[HW,DRM]
 
-	test_suspend=	[SUSPEND][,N]
+	test_suspend=	[SUSPEND]
+			Format: { "mem" | "standby" | "freeze" }[,N]
 			Specify "mem" (for Suspend-to-RAM) or "standby" (for
 			standby suspend) or "freeze" (for suspend type freeze)
 			as the system sleep state during system startup with
@@ -5902,6 +5910,8 @@ 
 	trace_buf_size=nn[KMG]
 			[FTRACE] will set tracing buffer size on each cpu.
 
+	trace_clock=	[FTRACE] See Documentation/trace/ftrace.rst
+
 	trace_event=[event-list]
 			[FTRACE] Set and start specified trace events in order
 			to facilitate early boot debugging. The event-list is a
@@ -5924,7 +5934,7 @@ 
 			See also Documentation/trace/ftrace.rst "trace options"
 			section.
 
-	tp_printk[FTRACE]
+	tp_printk	[FTRACE]
 			Have the tracepoints sent to printk as well as the
 			tracing ring buffer. This is useful for early boot up
 			where the system hangs or reboots and does not give the
@@ -5946,7 +5956,7 @@ 
 			frequency tracepoints such as irq or sched, can cause
 			the system to live lock.
 
-	tp_printk_stop_on_boot[FTRACE]
+	tp_printk_stop_on_boot [FTRACE]
 			When tp_printk (above) is set, it can cause a lot of noise
 			on the console. It may be useful to only include the
 			printing of events during boot up, as user space may
@@ -6295,7 +6305,7 @@ 
 					HIGHMEM regardless of setting
 					of CONFIG_HIGHPTE.
 
-	vdso=		[X86,SH]
+	vdso=		[X86,SH,SPARC]
 			On X86_32, this is an alias for vdso32=.  Otherwise:
 
 			vdso=1: enable VDSO (the default)
@@ -6321,11 +6331,12 @@ 
 	video=		[FB] Frame buffer configuration
 			See Documentation/fb/modedb.rst.
 
-	video.brightness_switch_enabled= [0,1]
+	video.brightness_switch_enabled= [ACPI]
+			Format: [0|1]
 			If set to 1, on receiving an ACPI notify event
 			generated by hotkey, video driver will adjust brightness
 			level and then send out the event to user space through
-			the allocated input device; If set to 0, video driver
+			the allocated input device. If set to 0, video driver
 			will only send out the event without touching backlight
 			brightness level.
 			default: 1