linux-trace-devel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Steven Rostedt <rostedt@goodmis.org>
To: Linux Trace Devel <linux-trace-devel@vger.kernel.org>
Cc: Yordan Karadzhov <y.karadz@gmail.com>
Subject: [PATCH] libtracefs: Remove tracefs_option_set/clear() from man page
Date: Fri, 9 Apr 2021 11:56:02 -0400	[thread overview]
Message-ID: <20210409115602.3b74bf66@gandalf.local.home> (raw)

From: "Steven Rostedt (VMware)" <rostedt@goodmis.org>

Since the functions tracefs_option_set() and tracefs_option_clear() is no
longer part of the API, remove it from the man page.

Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
---
 Documentation/libtracefs-option-bits.txt | 16 ++--------------
 1 file changed, 2 insertions(+), 14 deletions(-)

diff --git a/Documentation/libtracefs-option-bits.txt b/Documentation/libtracefs-option-bits.txt
index d713a5e..132bc13 100644
--- a/Documentation/libtracefs-option-bits.txt
+++ b/Documentation/libtracefs-option-bits.txt
@@ -3,8 +3,7 @@ libtracefs(3)
 
 NAME
 ----
-tracefs_option_set, tracefs_option_clear, tracefs_option_is_set -
-Set, clear, check option in a bitmask.
+tracefs_option_is_set - Check if an option is set.
 
 SYNOPSIS
 --------
@@ -12,20 +11,11 @@ SYNOPSIS
 --
 *#include <tracefs.h>*
 
-void *tracefs_option_set*(struct tracefs_options_mask pass:[*]_options_, enum tracefs_option_id _id_);
-void *tracefs_option_clear*(struct tracefs_options_mask pass:[*]_options_, enum tracefs_option_id _id_);
 bool *tracefs_option_is_set*(struct tracefs_options_mask _options_, enum tracefs_option_id _id_);
 --
 
 DESCRIPTION
 -----------
-This set of APIs can be used to manipulate a bitmask with option IDs.
-
-The _tracefs_option_set()_ function sets the bit, corresponding to the option with _id_ in the
-_options_ bitmask.
-
-The _tracefs_option_clear()_ function clears the bit, corresponding to the option with _id_ in the
-_options_ bitmask.
 
 The _tracefs_option_is_set()_ function checks if the bit, corresponding to the option with _id_ is
 set in the _options_ bitmask.
@@ -43,10 +33,8 @@ EXAMPLE
 struct tracefs_options_mask options;
 memset(&options, 0, sizeof(options));
 ...
-tracefs_option_set(&options, TRACEFS_OPTION_EVENT_FORK | TRACEFS_OPTION_FUNCTION_FORK);
-...
 if (tracefs_option_is_set(options, TRACEFS_OPTION_EVENT_FORK))
-	tracefs_option_clear(&options, TRACEFS_OPTION_EVENT_FORK);
+	enable_fork_code();
 ...
 --
 FILES
-- 
2.29.2


             reply	other threads:[~2021-04-09 15:56 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-09 15:56 Steven Rostedt [this message]
2021-04-09 16:47 ` [PATCH] libtracefs: Remove tracefs_option_set/clear() from man page Steven Rostedt

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210409115602.3b74bf66@gandalf.local.home \
    --to=rostedt@goodmis.org \
    --cc=linux-trace-devel@vger.kernel.org \
    --cc=y.karadz@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).