From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1756801AbYHAUv1 (ORCPT ); Fri, 1 Aug 2008 16:51:27 -0400 Received: (majordomo@vger.kernel.org) by vger.kernel.org id S1759879AbYHAUvB (ORCPT ); Fri, 1 Aug 2008 16:51:01 -0400 Received: from rgminet01.oracle.com ([148.87.113.118]:10442 "EHLO rgminet01.oracle.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1759693AbYHAUvA (ORCPT ); Fri, 1 Aug 2008 16:51:00 -0400 Date: Fri, 1 Aug 2008 13:49:05 -0700 From: Randy Dunlap To: Steven Rostedt Cc: linux-kernel@vger.kernel.org, Ingo Molnar , Peter Zijlstra , Thomas Gleixner , Andrew Morton , Steven Rostedt Subject: Re: [PATCH v3 3/2] ftrace: ftrace_printk doc moved Message-Id: <20080801134905.bff99511.randy.dunlap@oracle.com> In-Reply-To: References: <20080801162639.175407419@goodmis.org> <20080801163737.420519487@goodmis.org> <20080801094331.626195c8.randy.dunlap@oracle.com> <20080801105255.82a6520f.randy.dunlap@oracle.com> <20080801133427.51b17904.randy.dunlap@oracle.com> Organization: Oracle Linux Eng. X-Mailer: Sylpheed 2.5.0 (GTK+ 2.12.0; x86_64-unknown-linux-gnu) Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit X-Brightmail-Tracker: AAAAAQAAAAI= X-Brightmail-Tracker: AAAAAQAAAAI= X-Whitelist: TRUE X-Whitelist: TRUE Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Fri, 1 Aug 2008 16:45:49 -0400 (EDT) Steven Rostedt wrote: > > Based on Randy Dunlap's suggestion, the ftrace_printk kernel-doc belongs > with the ftrace_printk macro that should be used. Not with the > __ftrace_printk internal function. > > Signed-off-by: Steven Rostedt Acked-by: Randy Dunlap > --- > include/linux/ftrace.h | 19 ++++++++++++++++++- > kernel/trace/trace.c | 16 ---------------- > 2 files changed, 18 insertions(+), 17 deletions(-) > > Index: linux-tip.git/include/linux/ftrace.h > =================================================================== > --- linux-tip.git.orig/include/linux/ftrace.h 2008-08-01 12:20:56.000000000 -0400 > +++ linux-tip.git/include/linux/ftrace.h 2008-08-01 16:43:56.000000000 -0400 > @@ -137,7 +137,24 @@ static inline void tracer_disable(void) > extern void > ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3); > extern void ftrace_dump(void); > -# define ftrace_printk(x...) __ftrace_printk(_THIS_IP_, x) > + > +/** > + * ftrace_printk - printf formatting in the ftrace buffer > + * @fmt: the printf format for printing > + * > + * Note: __ftrace_printk is an internal function for ftrace_printk and > + * the @ip is passed in via the ftrace_printk macro. > + * > + * This function allows a kernel developer to debug fast path sections > + * that printk is not appropriate for. By scattering in various > + * printk like tracing in the code, a developer can quickly see > + * where problems are occurring. > + * > + * This is intended as a debugging tool for the developer only. > + * Please refrain from leaving ftrace_printks scattered around in > + * your code. > + */ > +# define ftrace_printk(fmt...) __ftrace_printk(_THIS_IP_, fmt) > extern int > __ftrace_printk(unsigned long ip, const char *fmt, ...) > __attribute__ ((format (printf, 2, 3))); > Index: linux-tip.git/kernel/trace/trace.c > =================================================================== > --- linux-tip.git.orig/kernel/trace/trace.c 2008-08-01 12:20:56.000000000 -0400 > +++ linux-tip.git/kernel/trace/trace.c 2008-08-01 14:10:36.000000000 -0400 > @@ -3243,22 +3243,6 @@ void ftrace_dump(void) > (sizeof(struct trace_field) - offsetof(struct trace_field, print.buf)) > #define TRACE_CONT_BUF_SIZE sizeof(struct trace_field) > > -/** > - * ftrace_printk - printf formatting in the ftrace buffer > - * @fmt - the printf format for printing. > - * > - * Note: __ftrace_printk is an internal function for ftrace_printk and > - * the @ip is passed in via the ftrace_printk macro. > - * > - * This function allows a kernel developer to debug fast path sections > - * that printk is not appropriate for. By scattering in various > - * printk like tracing in the code, a developer can quickly see > - * where problems are occurring. > - * > - * This is intended as a debugging tool for the developer only. > - * Please reframe from leaving ftrace_printks scattered around in > - * your code. > - */ > int __ftrace_printk(unsigned long ip, const char *fmt, ...) > { > struct trace_array *tr = &global_trace; --- ~Randy Linux Plumbers Conference, 17-19 September 2008, Portland, Oregon USA http://linuxplumbersconf.org/