2024-03-23 23:17:24

by Vitaly Chikunov

Subject: [PATCH] tracing: Fix documentation on tp_printk cmdline option

kernel-parameters.txt incorrectly states that workings of
kernel.tracepoint_printk sysctl depends on "tracepoint_printk kernel
cmdline option", this is a bit misleading for new users since the actual
cmdline option name is tp_printk.

Fixes: 0daa2302968c ("tracing: Add tp_printk cmdline to have tracepoints go to printk()")
Signed-off-by: Vitaly Chikunov <[email protected]>
---
Documentation/admin-guide/kernel-parameters.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index bb884c14b2f6..623fce7d5fcd 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -6599,7 +6599,7 @@
To turn off having tracepoints sent to printk,
echo 0 > /proc/sys/kernel/tracepoint_printk
Note, echoing 1 into this file without the
- tracepoint_printk kernel cmdline option has no effect.
+ tp_printk kernel cmdline option has no effect.

The tp_printk_stop_on_boot (see below) can also be used
to stop the printing of events to console at
--
2.42.1

2024-03-24 00:30:03

by Randy Dunlap

Subject: Re: [PATCH] tracing: Fix documentation on tp_printk cmdline option

On 3/23/24 16:17, Vitaly Chikunov wrote:
> kernel-parameters.txt incorrectly states that workings of
> kernel.tracepoint_printk sysctl depends on "tracepoint_printk kernel
> cmdline option", this is a bit misleading for new users since the actual
> cmdline option name is tp_printk.
>
> Fixes: 0daa2302968c ("tracing: Add tp_printk cmdline to have tracepoints go to printk()")
> Signed-off-by: Vitaly Chikunov <[email protected]>

Reviewed-by: Randy Dunlap <[email protected]>

Thanks.

> ---
> Documentation/admin-guide/kernel-parameters.txt | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> index bb884c14b2f6..623fce7d5fcd 100644
> --- a/Documentation/admin-guide/kernel-parameters.txt
> +++ b/Documentation/admin-guide/kernel-parameters.txt
> @@ -6599,7 +6599,7 @@
> To turn off having tracepoints sent to printk,
> echo 0 > /proc/sys/kernel/tracepoint_printk
> Note, echoing 1 into this file without the
> - tracepoint_printk kernel cmdline option has no effect.
> + tp_printk kernel cmdline option has no effect.
>
> The tp_printk_stop_on_boot (see below) can also be used
> to stop the printing of events to console at

--
#Randy

2024-03-29 15:17:21

by Jonathan Corbet

Subject: Re: [PATCH] tracing: Fix documentation on tp_printk cmdline option

Vitaly Chikunov <[email protected]> writes:

> kernel-parameters.txt incorrectly states that workings of
> kernel.tracepoint_printk sysctl depends on "tracepoint_printk kernel
> cmdline option", this is a bit misleading for new users since the actual
> cmdline option name is tp_printk.
>
> Fixes: 0daa2302968c ("tracing: Add tp_printk cmdline to have tracepoints go to printk()")
> Signed-off-by: Vitaly Chikunov <[email protected]>
> ---
> Documentation/admin-guide/kernel-parameters.txt | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)

Applied, thanks.

jon