From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.0 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, MENTIONS_GIT_HOSTING,SIGNED_OFF_BY,SPF_PASS,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id CEE60C43381 for ; Wed, 13 Mar 2019 20:32:57 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 9FE1A213A2 for ; Wed, 13 Mar 2019 20:32:57 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726889AbfCMUc5 (ORCPT ); Wed, 13 Mar 2019 16:32:57 -0400 Received: from mail.kernel.org ([198.145.29.99]:46780 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726787AbfCMUc5 (ORCPT ); Wed, 13 Mar 2019 16:32:57 -0400 Received: from gandalf.local.home (cpe-66-24-58-225.stny.res.rr.com [66.24.58.225]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 3381A20854; Wed, 13 Mar 2019 20:32:56 +0000 (UTC) Date: Wed, 13 Mar 2019 16:32:54 -0400 From: Steven Rostedt To: Tzvetomir Stoyanov Cc: linux-trace-devel@vger.kernel.org Subject: Re: [PATCH v4 40/46] tools/lib/traceevent: Man page for tep_data_lat_fmt() Message-ID: <20190313163254.05df11ae@gandalf.local.home> In-Reply-To: <20190308133654.21264-41-tstoyanov@vmware.com> References: <20190308133654.21264-1-tstoyanov@vmware.com> <20190308133654.21264-41-tstoyanov@vmware.com> X-Mailer: Claws Mail 3.16.0 (GTK+ 2.24.32; x86_64-pc-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: linux-trace-devel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-trace-devel@vger.kernel.org On Fri, 8 Mar 2019 15:36:48 +0200 Tzvetomir Stoyanov wrote: > Create man page for tep_data_lat_fmt() > as part of the libtraceevent APIs. This should be included in the same man page as tep_set_latency_format and tep_is_latency_format. -- Steve > > Signed-off-by: Tzvetomir Stoyanov > --- > .../libtraceevent-record_lat.txt | 77 +++++++++++++++++++ > 1 file changed, 77 insertions(+) > create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-record_lat.txt > > diff --git a/tools/lib/traceevent/Documentation/libtraceevent-record_lat.txt b/tools/lib/traceevent/Documentation/libtraceevent-record_lat.txt > new file mode 100644 > index 000000000000..f4e37b186f61 > --- /dev/null > +++ b/tools/lib/traceevent/Documentation/libtraceevent-record_lat.txt > @@ -0,0 +1,77 @@ > +libtraceevent(3) > +================ > + > +NAME > +---- > +tep_data_lat_fmt - Parses the data for the latency format. > + > +SYNOPSIS > +-------- > +[verse] > +-- > +*#include * > + > +void *tep_data_lat_fmt*(struct tep_handle pass:[*]_tep_, struct trace_seq pass:[*]_s_, struct tep_record pass:[*]_record_); > +-- > +DESCRIPTION > +----------- > +The _tep_data_lat_fmt()_ function parses out the latency format (interrupts > +disabled, need rescheduling, in hard/soft interrupt, preempt count and > +lock depth) from _record_ and places it into the _s_. The _tep_ argument is > +the trace event parser context. > + > +EXAMPLE > +------- > +[source,c] > +-- > +#include > +#include > +... > +struct tep_handle *tep = tep_alloc(); > +struct trace_seq seq; > +trace_seq_init(&seq); > +... > +void process_record(struct tep_record *record) > +{ > + /* Place latency information in the seq */ > + tep_data_lat_fmt(tep, &seq, record); > +} > +... > +-- > + > +FILES > +----- > +[verse] > +-- > +*event-parse.h* > + Header file to include in order to have access to the library APIs. > +*trace-seq.h* > + Header file to include in order to have access to trace sequences related APIs. > + Trace sequences are used to allow a function to call several other functions > + to create a string of data to use. > +*-ltraceevent* > + Linker switch to add when building a program that uses the library. > +-- > + > +SEE ALSO > +-------- > +_libtraceevent(3)_, _trace-cmd(1)_,_tep_set_latency_format(3)_ > + > +AUTHOR > +------ > +[verse] > +-- > +*Steven Rostedt* , author of *libtraceevent*. > +*Tzvetomir Stoyanov* , author of this man page. > +-- > +REPORTING BUGS > +-------------- > +Report bugs to > + > +LICENSE > +------- > +libtraceevent is Free Software licensed under the GNU LGPL 2.1 > + > +RESOURCES > +--------- > +https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git