From patchwork Tue Nov 27 15:42:49 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tzvetomir Stoyanov X-Patchwork-Id: 10759957 Return-Path: Received: from mail-eopbgr690079.outbound.protection.outlook.com ([40.107.69.79]:56248 "EHLO NAM04-CO1-obe.outbound.protection.outlook.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1726681AbeK1Cln (ORCPT ); Tue, 27 Nov 2018 21:41:43 -0500 From: Tzvetomir Stoyanov To: "rostedt@goodmis.org" CC: "linux-trace-devel@vger.kernel.org" Subject: [PATCH v3 33/46] tools/lib/traceevent: Man page for tep_filter_make_string() Date: Tue, 27 Nov 2018 15:42:49 +0000 Message-ID: <20181127154153.11315-34-tstoyanov@vmware.com> References: <20181127154153.11315-1-tstoyanov@vmware.com> In-Reply-To: <20181127154153.11315-1-tstoyanov@vmware.com> Content-Language: en-US MIME-Version: 1.0 Sender: linux-trace-devel-owner@vger.kernel.org List-ID: Content-Length: 2303 Create man page for tep_filter_make_string() as part of the libtraceevent APIs. Signed-off-by: Tzvetomir Stoyanov --- .../libtraceevent-filter_show.txt | 75 +++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-filter_show.txt diff --git a/tools/lib/traceevent/Documentation/libtraceevent-filter_show.txt b/tools/lib/traceevent/Documentation/libtraceevent-filter_show.txt new file mode 100644 index 000000000000..889b9328f87f --- /dev/null +++ b/tools/lib/traceevent/Documentation/libtraceevent-filter_show.txt @@ -0,0 +1,75 @@ +libtraceevent(3) +================ + +NAME +---- +tep_filter_make_string - Returns a string showing the filter. + +SYNOPSIS +-------- +[verse] +-- +*#include * + +char pass:[*]*tep_filter_make_string*(struct tep_event_filter pass:[*]_filter_, int _event_id_); +-- + +DESCRIPTION +----------- +The _tep_filter_make_string()_ function constructs a string, displaying +the _filter_ contents for given _event_id_. + +RETURN VALUE +------------ +The _tep_filter_make_string()_ function returns a string, which must be freed +with free(), or NULL in case of an error. + +EXAMPLE +------- +[source,c] +-- +#include +... +struct tep_handle *tep = tep_alloc(); +struct tep_event_filter *filter = tep_filter_alloc(tep); +... +char *fstring = tep_filter_make_string(filter, 352); +if (fstring != NULL) { + /* The filter for event 352 is in fstring */ + free(fstring); +} +... +-- + +FILES +----- +[verse] +-- +*event-parse.h* + Header file to include in order to have access to the library APIs. +*-ltraceevent* + Linker switch to add when building a program that uses the library. +-- + +SEE ALSO +-------- +_libtraceevent(3)_, _trace-cmd(1)_ + +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