* [PATCH] doc: clarify that trace_events= takes a comma-separated list
@ 2016-05-23 20:08 Brian Norris
2016-05-23 20:25 ` Steven Rostedt
2016-05-23 20:37 ` [PATCH v2] " Brian Norris
0 siblings, 2 replies; 6+ messages in thread
From: Brian Norris @ 2016-05-23 20:08 UTC (permalink / raw)
To: Steven Rostedt
Cc: linux-kernel, linux-doc, Brian Norris, Jonathan Corbet, Li Zefan
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 <computersforpeace@gmail.com>
---
Documentation/kernel-parameters.txt | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
index 5349363b603c..594bf50b8f81 100644
--- a/Documentation/kernel-parameters.txt
+++ b/Documentation/kernel-parameters.txt
@@ -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]
--
2.8.0.rc3.226.g39d4020
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH] doc: clarify that trace_events= takes a comma-separated list
2016-05-23 20:08 [PATCH] doc: clarify that trace_events= takes a comma-separated list Brian Norris
@ 2016-05-23 20:25 ` Steven Rostedt
2016-05-23 20:32 ` Brian Norris
2016-05-23 20:37 ` [PATCH v2] " Brian Norris
1 sibling, 1 reply; 6+ messages in thread
From: Steven Rostedt @ 2016-05-23 20:25 UTC (permalink / raw)
To: Brian Norris; +Cc: linux-kernel, linux-doc, Jonathan Corbet, Li Zefan
On Mon, 23 May 2016 13:08:31 -0700
Brian Norris <computersforpeace@gmail.com> wrote:
Hi Brian,
> 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 <computersforpeace@gmail.com>
> ---
> Documentation/kernel-parameters.txt | 7 ++++++-
> 1 file changed, 6 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
> index 5349363b603c..594bf50b8f81 100644
> --- a/Documentation/kernel-parameters.txt
> +++ b/Documentation/kernel-parameters.txt
> @@ -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
> See also Documentation/trace/events.txt
>
> trace_options=[option-list]
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] doc: clarify that trace_events= takes a comma-separated list
2016-05-23 20:25 ` Steven Rostedt
@ 2016-05-23 20:32 ` Brian Norris
0 siblings, 0 replies; 6+ messages in thread
From: Brian Norris @ 2016-05-23 20:32 UTC (permalink / raw)
To: Steven Rostedt; +Cc: linux-kernel, linux-doc, Jonathan Corbet, Li Zefan
On Mon, May 23, 2016 at 04:25:44PM -0400, Steven Rostedt wrote:
> On Mon, 23 May 2016 13:08:31 -0700
> Brian Norris <computersforpeace@gmail.com> wrote:
>
> > 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 <computersforpeace@gmail.com>
> > ---
> > Documentation/kernel-parameters.txt | 7 ++++++-
> > 1 file changed, 6 insertions(+), 1 deletion(-)
> >
> > diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
> > index 5349363b603c..594bf50b8f81 100644
> > --- a/Documentation/kernel-parameters.txt
> > +++ b/Documentation/kernel-parameters.txt
> > @@ -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.
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.
> 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
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH v2] doc: clarify that trace_events= takes a comma-separated list
2016-05-23 20:08 [PATCH] doc: clarify that trace_events= takes a comma-separated list Brian Norris
2016-05-23 20:25 ` Steven Rostedt
@ 2016-05-23 20:37 ` Brian Norris
2016-05-23 20:54 ` Steven Rostedt
1 sibling, 1 reply; 6+ messages in thread
From: Brian Norris @ 2016-05-23 20:37 UTC (permalink / raw)
To: Steven Rostedt
Cc: linux-kernel, linux-doc, Brian Norris, Jonathan Corbet, Li Zefan
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 <computersforpeace@gmail.com>
---
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(-)
diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
index 82b42c958d1c..a2a662d4da83 100644
--- a/Documentation/kernel-parameters.txt
+++ b/Documentation/kernel-parameters.txt
@@ -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.
--
2.8.0.rc3.226.g39d4020
^ permalink raw reply related [flat|nested] 6+ messages in thread* Re: [PATCH v2] doc: clarify that trace_events= takes a comma-separated list
2016-05-23 20:37 ` [PATCH v2] " Brian Norris
@ 2016-05-23 20:54 ` Steven Rostedt
2016-05-23 20:56 ` Jonathan Corbet
0 siblings, 1 reply; 6+ messages in thread
From: Steven Rostedt @ 2016-05-23 20:54 UTC (permalink / raw)
To: Brian Norris; +Cc: linux-kernel, linux-doc, Jonathan Corbet, Li Zefan
On Mon, 23 May 2016 13:37:58 -0700
Brian Norris <computersforpeace@gmail.com> wrote:
> 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?
Acked-by: Steven Rostedt <rostedt@goodmis.org>
-- Steve
> Signed-off-by: Brian Norris <computersforpeace@gmail.com>
> ---
> 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(-)
>
> diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
> index 82b42c958d1c..a2a662d4da83 100644
> --- a/Documentation/kernel-parameters.txt
> +++ b/Documentation/kernel-parameters.txt
> @@ -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.
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2016-05-23 20:57 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2016-05-23 20:08 [PATCH] doc: clarify that trace_events= takes a comma-separated list Brian Norris
2016-05-23 20:25 ` Steven Rostedt
2016-05-23 20:32 ` Brian Norris
2016-05-23 20:37 ` [PATCH v2] " Brian Norris
2016-05-23 20:54 ` Steven Rostedt
2016-05-23 20:56 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox