From patchwork Fri Mar 8 13:36:36 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tzvetomir Stoyanov X-Patchwork-Id: 10844809 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 1ACA91390 for ; Fri, 8 Mar 2019 13:37:26 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 075E22E40A for ; Fri, 8 Mar 2019 13:37:26 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id F01742E440; Fri, 8 Mar 2019 13:37:25 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.9 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 8EEDF2E40A for ; Fri, 8 Mar 2019 13:37:25 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726733AbfCHNhZ (ORCPT ); Fri, 8 Mar 2019 08:37:25 -0500 Received: from mail-wr1-f68.google.com ([209.85.221.68]:45929 "EHLO mail-wr1-f68.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726722AbfCHNhZ (ORCPT ); Fri, 8 Mar 2019 08:37:25 -0500 Received: by mail-wr1-f68.google.com with SMTP id o7so1293933wrp.12 for ; Fri, 08 Mar 2019 05:37:24 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Wh6TRkpAyO1kZo2dHBmbbrZh1XfT6EtR+AMfSgR1Vw8=; b=o7CTx1E9Boqbu35gcKy1RkgHYJJ4bHL5ywIjkx51f8T27XFVWAg81zC9/5lcLb08X/ 5uskZ1c39mA15qkdPXh+Kt7+jOJ8nt9bin55N7Ieh92D9mm2l9pb6lX28RvrMbU1YDDP sOq2fnnahx3bpIjJtwGkqC2oGKzelnVKCUkEztakF+iE3m+EoPSHEYaW1CNBftScRo+o Vxfqa0QTMLIJOo7tmaZ75SWogZWGjf90YBN+TAzM/fU+Egp4XyjnShR0n461kjLk9zN0 eTdfFULJNx1TXY5LW5TjpMMhZ1ay39J2w5rFRdr5FDhcdipnqTKEDjdMKmpzQg8ziJMD NlAw== X-Gm-Message-State: APjAAAWAxRT1YanMAp67oRTXpeugHL2CkzwKOmPWrr7e3ppZiN/r/0Ij hTAM6rt4SH6GshQYGfQsVw6A0pMy X-Google-Smtp-Source: APXvYqxXe+7uUpcXIG+3Kd4HF1Hkwg+i9CAMC556/mmoY29eigA5XyOS+Sz5/iP1zT/HatvA5w72kw== X-Received: by 2002:adf:f40d:: with SMTP id g13mr10948002wro.18.1552052243542; Fri, 08 Mar 2019 05:37:23 -0800 (PST) Received: from oberon.eng.vmware.com ([146.247.46.5]) by smtp.gmail.com with ESMTPSA id 132sm19625364wmd.27.2019.03.08.05.37.22 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 08 Mar 2019 05:37:22 -0800 (PST) From: Tzvetomir Stoyanov To: rostedt@goodmis.org Cc: linux-trace-devel@vger.kernel.org Subject: [PATCH v4 28/46] tools/lib/traceevent: Man page for tep_filter_add_filter_str() Date: Fri, 8 Mar 2019 15:36:36 +0200 Message-Id: <20190308133654.21264-29-tstoyanov@vmware.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190308133654.21264-1-tstoyanov@vmware.com> References: <20190308133654.21264-1-tstoyanov@vmware.com> MIME-Version: 1.0 Sender: linux-trace-devel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-trace-devel@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Create man page for tep_filter_add_filter_str() as part of the libtraceevent APIs. Signed-off-by: Tzvetomir Stoyanov --- .../libtraceevent-filter_add.txt | 78 +++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-filter_add.txt diff --git a/tools/lib/traceevent/Documentation/libtraceevent-filter_add.txt b/tools/lib/traceevent/Documentation/libtraceevent-filter_add.txt new file mode 100644 index 000000000000..5b8f67e406b2 --- /dev/null +++ b/tools/lib/traceevent/Documentation/libtraceevent-filter_add.txt @@ -0,0 +1,78 @@ +libtraceevent(3) +================ + +NAME +---- +tep_filter_add_filter_str - Adds a new rule to a filter. + +SYNOPSIS +-------- +[verse] +-- +*#include * + +enum tep_errno *tep_filter_add_filter_str*(struct tep_event_filter pass:[*]_filter_, const char pass:[*]_filter_str_); +-- + +DESCRIPTION +----------- +The _tep_filter_add_filter_str()_ function adds a new rule to the _filter_. The +_filter_str_ argument is the filter string, that contains the rule. + +RETURN VALUE +------------ +The _tep_filter_add_filter_str()_ function returns 0 if the rule was +successfully added or a negative error code. Use _tep_filter_strerror()_ to see +actual error message in case of an error. + +EXAMPLE +------- +[source,c] +-- +#include +... +struct tep_handle *tep = tep_alloc(); +struct tep_event_filter *filter = tep_filter_alloc(tep); +... +int ret; +char errstr[200]; +ret = tep_filter_add_filter_str(filter, "sched/sched_wakeup:target_cpu==1"); +if(ret < 0) { + tep_filter_strerror(filter, ret, errstr, sizeof(errstr)); + /* Failed to add a new rule to the filter, the error string is in errstr */ +} +... +-- + +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)_, _tep_filter_strerror(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