Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753694Ab3H0I5h (ORCPT ); Tue, 27 Aug 2013 04:57:37 -0400 Received: from cantor2.suse.de ([195.135.220.15]:58675 "EHLO mx2.suse.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752737Ab3H0I5f (ORCPT ); Tue, 27 Aug 2013 04:57:35 -0400 Date: Tue, 27 Aug 2013 10:57:30 +0200 (CEST) From: Jiri Kosina To: Mathieu Desnoyers Cc: Zoltan Kiss , Konrad Rzeszutek Wilk , Rob Landley , Steven Rostedt , Paul Bolle , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH] Documentation/trace: Correcting and extending tracepoint documentation In-Reply-To: <20130824185309.GA13216@Krystal> Message-ID: References: <1377208171-9004-1-git-send-email-zoltan.kiss@citrix.com> <20130824185309.GA13216@Krystal> User-Agent: Alpine 2.00 (LNX 1167 2008-08-23) MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 2517 Lines: 76 On Sat, 24 Aug 2013, Mathieu Desnoyers wrote: > * Zoltan Kiss (zoltan.kiss@citrix.com) wrote: > > The sample missed the moving of the header files into the events subdirectory. > > I've also extended it based on the existing headers, and mentioned the tiny > > but important role of CREATE_TRACE_POINTS. > > Given that we expect tracepoints to be used though the TRACE_EVENT > wrapper, it makes sense indeed. A small nit below: > > > > > Signed-off-by: Zoltan Kiss > > --- > > Documentation/trace/tracepoints.txt | 19 +++++++++++++++++-- > > 1 file changed, 17 insertions(+), 2 deletions(-) > > > > diff --git a/Documentation/trace/tracepoints.txt b/Documentation/trace/tracepoints.txt > > index da49437..e8e3c4b 100644 > > --- a/Documentation/trace/tracepoints.txt > > +++ b/Documentation/trace/tracepoints.txt > > @@ -40,7 +40,13 @@ Two elements are required for tracepoints : > > > > In order to use tracepoints, you should include linux/tracepoint.h. > > > > -In include/trace/subsys.h : > > +In include/trace/events/subsys.h : > > + > > +#undef TRACE_SYSTEM > > +#define TRACE_SYSTEM subsys > > + > > +#if !defined(_TRACE_SUBSYS_H) || defined(TRACE_HEADER_MULTI_READ) > > +#define _TRACE_SUBSYS_H > > > > #include > > > > @@ -48,10 +54,16 @@ DECLARE_TRACE(subsys_eventname, > > TP_PROTO(int firstarg, struct task_struct *p), > > TP_ARGS(firstarg, p)); > > > > +#endif /* _TRACE_SUBSYS_H */ > > + > > +/* This part must be outside protection */ > > +#include > > + > > In subsys/file.c (where the tracing statement must be added) : > > > > -#include > > +#include > > > > +#define CREATE_TRACE_POINTS > > DEFINE_TRACE(subsys_eventname); > > > > void somefct(void) > > @@ -72,6 +84,9 @@ Where : > > - TP_ARGS(firstarg, p) are the parameters names, same as found in the > > prototype. > > > > +- if you use the header in multiple source files, #define CREATE_TRACE_POINTS > > + should appear only in one source file > > Missing dot at the end of the sentence above. > > Other than that, > > Acked-by: Mathieu Desnoyers I have added the dot and applied :) -- Jiri Kosina SUSE Labs -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/