* [PATCH] libtracefs: Remove tracefs_option_set/clear() from man page
@ 2021-04-09 15:56 Steven Rostedt
2021-04-09 16:47 ` Steven Rostedt
0 siblings, 1 reply; 2+ messages in thread
From: Steven Rostedt @ 2021-04-09 15:56 UTC (permalink / raw)
To: Linux Trace Devel; +Cc: Yordan Karadzhov
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
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] libtracefs: Remove tracefs_option_set/clear() from man page
2021-04-09 15:56 [PATCH] libtracefs: Remove tracefs_option_set/clear() from man page Steven Rostedt
@ 2021-04-09 16:47 ` Steven Rostedt
0 siblings, 0 replies; 2+ messages in thread
From: Steven Rostedt @ 2021-04-09 16:47 UTC (permalink / raw)
To: Linux Trace Devel; +Cc: Yordan Karadzhov
On Fri, 9 Apr 2021 11:56:02 -0400
Steven Rostedt <rostedt@goodmis.org> wrote:
> 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.
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
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-04-09 16:47 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-09 15:56 [PATCH] libtracefs: Remove tracefs_option_set/clear() from man page Steven Rostedt
2021-04-09 16:47 ` Steven Rostedt
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.