Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1405604 > unrolled thread

[PATCH] doc: clarify that trace_events= takes a comma-separated list

Started byBrian Norris <computersforpeace@gmail.com>
First post2016-05-23 22:20 +0200
Last post2016-05-23 23:00 +0200
Articles 6 — 3 participants

Back to article view | Back to linux.kernel

Contents

  [PATCH] doc: clarify that trace_events= takes a comma-separated list Brian Norris <computersforpeace@gmail.com> - 2016-05-23 22:20 +0200
    Re: [PATCH] doc: clarify that trace_events= takes a comma-separated  list Steven Rostedt <rostedt@goodmis.org> - 2016-05-23 22:30 +0200
      Re: [PATCH] doc: clarify that trace_events= takes a comma-separated  list Brian Norris <computersforpeace@gmail.com> - 2016-05-23 22:40 +0200
    [PATCH v2] doc: clarify that trace_events= takes a comma-separated list Brian Norris <computersforpeace@gmail.com> - 2016-05-23 22:40 +0200
      Re: [PATCH v2] doc: clarify that trace_events= takes a  comma-separated list Jonathan Corbet <corbet@lwn.net> - 2016-05-23 23:00 +0200
      Re: [PATCH v2] doc: clarify that trace_events= takes a  comma-separated list Steven Rostedt <rostedt@goodmis.org> - 2016-05-23 23:00 +0200

#1405604 — [PATCH] doc: clarify that trace_events= takes a comma-separated list

FromBrian Norris <computersforpeace@gmail.com>
Date2016-05-23 22:20 +0200
Subject[PATCH] doc: clarify that trace_events= takes a comma-separated list
Message-ID<rC4uu-23X-5@gated-at.bofh.it>
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

[toc] | [next] | [standalone]

#1405607 — Re: [PATCH] doc: clarify that trace_events= takes a comma-separated list

FromSteven Rostedt <rostedt@goodmis.org>
Date2016-05-23 22:30 +0200
SubjectRe: [PATCH] doc: clarify that trace_events= takes a comma-separated list
Message-ID<rC4E9-27h-1@gated-at.bofh.it>
In reply to#1405604
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]

[toc] | [prev] | [next] | [standalone]

#1405614 — Re: [PATCH] doc: clarify that trace_events= takes a comma-separated list

FromBrian Norris <computersforpeace@gmail.com>
Date2016-05-23 22:40 +0200
SubjectRe: [PATCH] doc: clarify that trace_events= takes a comma-separated list
Message-ID<rC4NQ-2ay-25@gated-at.bofh.it>
In reply to#1405607
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

[toc] | [prev] | [next] | [standalone]

#1405610 — [PATCH v2] doc: clarify that trace_events= takes a comma-separated list

FromBrian Norris <computersforpeace@gmail.com>
Date2016-05-23 22:40 +0200
Subject[PATCH v2] doc: clarify that trace_events= takes a comma-separated list
Message-ID<rC4NP-2ay-13@gated-at.bofh.it>
In reply to#1405604
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

[toc] | [prev] | [next] | [standalone]

#1405623 — Re: [PATCH v2] doc: clarify that trace_events= takes a comma-separated list

FromJonathan Corbet <corbet@lwn.net>
Date2016-05-23 23:00 +0200
SubjectRe: [PATCH v2] doc: clarify that trace_events= takes a comma-separated list
Message-ID<rC57b-2h8-1@gated-at.bofh.it>
In reply to#1405610
On Mon, 23 May 2016 16:54:51 -0400
Steven Rostedt <rostedt@goodmis.org> wrote:

> This version looks good to me. Jonathan, you want to take this patch?

Sure, I'll take it.

Thanks,

jon

[toc] | [prev] | [next] | [standalone]

#1405626 — Re: [PATCH v2] doc: clarify that trace_events= takes a comma-separated list

FromSteven Rostedt <rostedt@goodmis.org>
Date2016-05-23 23:00 +0200
SubjectRe: [PATCH v2] doc: clarify that trace_events= takes a comma-separated list
Message-ID<rC57b-2h8-3@gated-at.bofh.it>
In reply to#1405610
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.

[toc] | [prev] | [standalone]

Back to top | Article view | linux.kernel

csiph-web