From patchwork Fri Mar 8 13:36:37 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tzvetomir Stoyanov X-Patchwork-Id: 10844811 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 1331E17E9 for ; Fri, 8 Mar 2019 13:37:27 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id F33532E40A for ; Fri, 8 Mar 2019 13:37:26 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id E7B7E2E440; Fri, 8 Mar 2019 13:37:26 +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 8617A2E40A for ; Fri, 8 Mar 2019 13:37:26 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726734AbfCHNh0 (ORCPT ); Fri, 8 Mar 2019 08:37:26 -0500 Received: from mail-wr1-f66.google.com ([209.85.221.66]:44826 "EHLO mail-wr1-f66.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726720AbfCHNh0 (ORCPT ); Fri, 8 Mar 2019 08:37:26 -0500 Received: by mail-wr1-f66.google.com with SMTP id w2so21389336wrt.11 for ; Fri, 08 Mar 2019 05:37:25 -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=K2nyS3OpjbzlgNx4KdcnUbUA5cdjGGXiq/FsyP8aCbE=; b=BWD2BBaiam2g/UbnrXkK7EweGKt2WVmwcRMSnZNTuRc3Bb8MDEAbcQsiSyI3p9Dtjq 61jk5/aoetQkpqH0tNAD6uwDh1upvjW752GsGlIOT+ToUlxpBRRFpU2WsrRvLnahKFsN /7AL/UkJrR0gE8OCfchrtMmggKmp4Fmhlky5CC+cOOSksBwQk7a3U2EHO/CnI4vsId5E jlKLZyJol70gUSAwgniAe2TnAoKpmIObVDKVyiUI+D//EDUq1wzWLbkT4Bep2ljZpy+U 81MyfK+en+9pwOVd5vbslDuu1st1/1EFE1ugSp4gsND10M0228YhJnzpcrWsH5CpDH/F Kcbg== X-Gm-Message-State: APjAAAV57yOCnwjbbZkWgFytuE02/GaFQNtWesHyAAxuw+frwOXVkjJK d7vYZffCxQMsgsb+oShml5RYVmbi X-Google-Smtp-Source: APXvYqxAkl6VY1BCPrW6GCHKnrX/8B4v2ie/eYHe13hdznYtkxa4OrirOkgE3Uryp3TsSZaLKDIpEA== X-Received: by 2002:a05:6000:10cf:: with SMTP id b15mr11280406wrx.32.1552052244489; Fri, 08 Mar 2019 05:37:24 -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.23 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 08 Mar 2019 05:37:24 -0800 (PST) From: Tzvetomir Stoyanov To: rostedt@goodmis.org Cc: linux-trace-devel@vger.kernel.org Subject: [PATCH v4 29/46] tools/lib/traceevent: Man page for tep_filter_strerror() Date: Fri, 8 Mar 2019 15:36:37 +0200 Message-Id: <20190308133654.21264-30-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_strerror() as part of the libtraceevent APIs. Signed-off-by: Tzvetomir Stoyanov --- .../libtraceevent-filter_error.txt | 78 +++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-filter_error.txt diff --git a/tools/lib/traceevent/Documentation/libtraceevent-filter_error.txt b/tools/lib/traceevent/Documentation/libtraceevent-filter_error.txt new file mode 100644 index 000000000000..57bd19ad5d53 --- /dev/null +++ b/tools/lib/traceevent/Documentation/libtraceevent-filter_error.txt @@ -0,0 +1,78 @@ +libtraceevent(3) +================ + +NAME +---- +tep_filter_strerror - Fills the filter error message in a buffer. + +SYNOPSIS +-------- +[verse] +-- +*#include * + +int *tep_filter_strerror*(struct tep_event_filter pass:[*]_filter_, enum tep_errno _err_, char pass:[*]buf, size_t _buflen_); +-- + +DESCRIPTION +----------- +The _tep_filter_strerror()_ function copies the _filter_ error buffer into the +given _buf_ with the size _buflen_. If the error buffer is empty, in the _buf_ +is copied a string, describing the error _err_. + +RETURN VALUE +------------ +The _tep_filter_strerror()_ function returns 0 if message was filled +successfully, or -1 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)_ + +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