doc: clarify that trace_events= takes a comma-separated list
PATCH 1/1 doc: clarify that trace_events= takes a comma-separated list
It took me browsing through the source code to determine that I was, indeed, using the wrong delimiter in my command lines. So I might as well document it for the next person.
--- Documentation/kernel-parameters.txt | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-)
Documentation/kernel-parameters.txt +6 -1
@@ -3994,7 +3994,12 @@ bytes respectively. Such letter suffixes can also be entirely omitted. trace_event=[event-list] [FTRACE] Set and start specified trace events in order - to facilitate early boot debugging. + to facilitate early boot debugging. The event-list is a + comma separated list of trace events to enable, as if + you were to append the event(s) to + + /sys/kernel/debug/tracing/set_event + See also Documentation/trace/events.txt trace_options=[option-list]
Signature · 1 line
2.8.0.rc3.226.g39d4020
On Mon, 23 May 2016 13:08:31 -0700
Brian Norris <[email protected]> wrote:
Hi Brian,
Quoted 14 lines
It took me browsing through the source code to determine that I was, indeed, using the wrong delimiter in my command lines. So I might as well document it for the next person.
Signed-off-by Brian Norris <[email protected]>--- Documentation/kernel-parameters.txt | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-)Documentation/kernel-parameters.txt +0
-0
Documentation/kernel-parameters.txt bytes respectively. Such letter suffixes can also be entirely omitted. · line 4002
Quoted 10 lines
Documentation/kernel-parameters.txt +6
-1@@ -3994,7 +3994,12 @@ bytes respectively. Such letter suffixes can also be entirely omitted. trace_event=[event-list] [FTRACE] Set and start specified trace events in order - to facilitate early boot debugging. + to facilitate early boot debugging. The event-list is a + comma separated list of trace events to enable, as if + you were to append the event(s) to + + /sys/kernel/debug/tracing/set_event +
I agree that we should document that the list is comma separated, but the wording you have above, makes it sound like the set_event file also takes a comma separated list, which it does not. That file requires a space separated list.
Can you reword that so that it removes the confusion. Thanks!
-- Steve
Quoted 3 lines
Documentation/kernel-parameters.txt +0
-0See also Documentation/trace/events.txt trace_options=[option-list]
Quoted 18 lines · Steven Rostedt
Quoted 15 lines · On Mon, 23 May 2016 13:08:31 -0700 Brian Norris <[email protected]>…
It took me browsing through the source code to determine that I was, indeed, using the wrong delimiter in my command lines. So I might as well document it for the next person.
Signed-off-by Brian Norris <[email protected]>--- Documentation/kernel-parameters.txt | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-)Documentation/kernel-parameters.txt +0
-0@@ -3994,7 +3994,12 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
Quoted 14 lines
Documentation/kernel-parameters.txt bytes respectively. Such letter suffixes can also be entirely omitted. · line 4002
Quoted 9 lines
Documentation/kernel-parameters.txt +6
-1trace_event=[event-list] [FTRACE] Set and start specified trace events in order - to facilitate early boot debugging. + to facilitate early boot debugging. The event-list is a + comma separated list of trace events to enable, as if + you were to append the event(s) to + + /sys/kernel/debug/tracing/set_event +I agree that we should document that the list is comma separated, but the wording you have above, makes it sound like the
set_eventfile also takes a comma separated list, which it does not. That file requires a space separated list.
Hmm, good point. I added the latter half of the sentence at the last moment, so I didn't give that part as good of a read.
Quoted 1 line
Can you reword that so that it removes the confusion. Thanks!
Sure, I'll try. Would it be OK if I just dropped the latter part of the sentence, and didn't mention /sys/.../set_event at all? Like:
"The event-list is a comma separated list of trace events to enable. See also Documentation/trace/events.txt"
Brian
PATCH v2 1/1 doc: clarify that trace_events= takes a comma-separated list
In reply to Brian NorrisIt took me browsing through the source code to determine that I was, indeed, using the wrong delimiter in my command lines. So I might as well document it for the next person.
---
v2: remove language about /sys/kernel/debug/tracing/set_event, to avoid
implying it also takes a comma separated list
Documentation/kernel-parameters.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
Documentation/kernel-parameters.txt +3 -2
@@ -3992,8 +3992,9 @@ bytes respectively. Such letter suffixes can also be entirely omitted. trace_event=[event-list] [FTRACE] Set and start specified trace events in order - to facilitate early boot debugging. - See also Documentation/trace/events.txt + to facilitate early boot debugging. The event-list is a + comma separated list of trace events to enable. See + also Documentation/trace/events.txt trace_options=[option-list] [FTRACE] Enable or disable tracer options at boot.
Signature · 1 line
2.8.0.rc3.226.g39d4020
Quoted 4 lines · On Mon, 23 May 2016 13:37:58 -0700 Brian Norris <[email protected]>…
It took me browsing through the source code to determine that I was, indeed, using the wrong delimiter in my command lines. So I might as well document it for the next person.
This version looks good to me. Jonathan, you want to take this patch?
-- Steve
Quoted 24 lines
Signed-off-by Brian Norris <[email protected]>---
v2: remove language about/sys/kernel/debug/tracing/set_event, to avoid
implying it also takes a comma separated listDocumentation/kernel-parameters.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)Documentation/kernel-parameters.txt +3
-2@@ -3992,8 +3992,9 @@ bytes respectively. Such letter suffixes can also be entirely omitted. trace_event=[event-list] [FTRACE] Set and start specified trace events in order - to facilitate early boot debugging. - See also Documentation/trace/events.txt + to facilitate early boot debugging. The event-list is a + comma separated list of trace events to enable. See + also Documentation/trace/events.txt trace_options=[option-list] [FTRACE] Enable or disable tracer options at boot.
Jonathan Corbet
maintainerQuoted 1 line · On Mon, 23 May 2016 16:54:51 -0400 Steven Rostedt <[email protected]> wrote:
This version looks good to me. Jonathan, you want to take this patch?
Sure, I'll take it.
Thanks,
jon