libtraceevent: Man pages fix, rename tep_ref_get() to tep_get_ref()
authorTzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com>
Thu, 19 Sep 2019 21:23:37 +0000 (17:23 -0400)
committerArnaldo Carvalho de Melo <acme@redhat.com>
Wed, 25 Sep 2019 12:51:43 +0000 (09:51 -0300)
The tep_ref_get() was renamed to tep_get_ref(), to be more consistent
with the other tep_ref_* APIs. However, in the man pages the API is
still with the old name. The documentation is fixed to reflect the
actual name of the API.

Signed-off-by: Tzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Jiri Olsa <jolsa@redhat.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Tzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com>
Cc: linux-trace-devel@vger.kernel.org
Link: http://lore.kernel.org/linux-trace-devel/20190808113636.13299-2-tz.stoyanov@gmail.com
Link: http://lore.kernel.org/lkml/20190919212541.697034573@goodmis.org
Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
tools/lib/traceevent/Documentation/libtraceevent-handle.txt
tools/lib/traceevent/Documentation/libtraceevent.txt

index 8d56831..45b2017 100644 (file)
@@ -3,7 +3,7 @@ libtraceevent(3)
 
 NAME
 ----
-tep_alloc, tep_free,tep_ref, tep_unref,tep_ref_get - Create, destroy, manage
+tep_alloc, tep_free,tep_ref, tep_unref,tep_get_ref - Create, destroy, manage
 references of trace event parser context.
 
 SYNOPSIS
@@ -16,7 +16,7 @@ struct tep_handle pass:[*]*tep_alloc*(void);
 void *tep_free*(struct tep_handle pass:[*]_tep_);
 void *tep_ref*(struct tep_handle pass:[*]_tep_);
 void *tep_unref*(struct tep_handle pass:[*]_tep_);
-int *tep_ref_get*(struct tep_handle pass:[*]_tep_);
+int *tep_get_ref*(struct tep_handle pass:[*]_tep_);
 --
 
 DESCRIPTION
@@ -57,9 +57,9 @@ EXAMPLE
 ...
 struct tep_handle *tep = tep_alloc();
 ...
-int ref = tep_ref_get(tep);
+int ref = tep_get_ref(tep);
 tep_ref(tep);
-if ( (ref+1) != tep_ref_get(tep)) {
+if ( (ref+1) != tep_get_ref(tep)) {
        /* Something wrong happened, the counter is not incremented by 1 */
 }
 tep_unref(tep);
index fbd977b..0051950 100644 (file)
@@ -16,7 +16,7 @@ Management of tep handler data structure and access of its members:
        void *tep_free*(struct tep_handle pass:[*]_tep_);
        void *tep_ref*(struct tep_handle pass:[*]_tep_);
        void *tep_unref*(struct tep_handle pass:[*]_tep_);
-       int *tep_ref_get*(struct tep_handle pass:[*]_tep_);
+       int *tep_get_ref*(struct tep_handle pass:[*]_tep_);
        void *tep_set_flag*(struct tep_handle pass:[*]_tep_, enum tep_flag _flag_);
        void *tep_clear_flag*(struct tep_handle pass:[*]_tep_, enum tep_flag _flag_);
        bool *tep_test_flag*(struct tep_handle pass:[*]_tep_, enum tep_flag _flags_);