libtracefs: Remove tracefs_option_set/clear() from man page

Commit Message

Steven Rostedt April 9, 2021, 3:56 p.m. UTC

From: "Steven Rostedt (VMware)" <[e-mail]>

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) <[e-mail]>
---
 Documentation/libtracefs-option-bits.txt | 16 ++--------------
 1 file changed, 2 insertions(+), 14 deletions(-)

Comments

Steven Rostedt April 9, 2021, 4:47 p.m. UTC | #1

On Fri, 9 Apr 2021 11:56:02 -0400
Steven Rostedt <[e-mail]> wrote:

> From: "Steven Rostedt (VMware)" <[e-mail]>
> 
> Since the functions tracefs_option_set() and tracefs_option_clear() is no
> longer part of the API, remove it from the man page.

As tracefs_option_set() has been renamed and is tightly related to the the
other options functions, I'm going to remove this file and add the
documentation of tracefs_option_mask_is_set() in the man pages of the other
functions.

-- Steve

Patch

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