Commit 489b3494 authored by Tzvetomir Stoyanov's avatar Tzvetomir Stoyanov Committed by Arnaldo Carvalho de Melo
Browse files

tools lib traceevent: Change description of few APIs 



APIs descriptions should describe the purpose of the function, its
parameters and return value. While working  on man pages implementation,
I noticed mismatches in the  descriptions of few APIs.  This patch
changes the description of these APIs, making them consistent with the
man pages:

 - tep_print_num_field()
 - tep_print_func_field()
 - tep_get_header_page_size()
 - tep_get_long_size()
 - tep_set_long_size()
 - tep_get_page_size()
 - tep_set_page_size()

Signed-off-by: default avatarTzvetomir Stoyanov <tstoyanov@vmware.com>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Jiri Olsa <jolsa@redhat.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Link: http://lore.kernel.org/linux-trace-devel/20190325145017.30246-2-tstoyanov@vmware.com
Link: http://lkml.kernel.org/r/20190401164343.396759247@goodmis.org


Signed-off-by: default avatarSteven Rostedt (VMware) <rostedt@goodmis.org>
Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent 70df6a73

tools/lib/traceevent/event-parse-api.c

+10 −10
Original line number Diff line number Diff line
@@ -43,7 +43,7 @@ int tep_get_events_count(struct tep_handle *tep) 
 * @flag: flag, or combination of flags to be set

 * can be any combination from enum tep_flag

 *

 * This sets a flag or mbination of flags  from enum tep_flag

 * This sets a flag or combination of flags from enum tep_flag

 */

void tep_set_flag(struct tep_handle *tep, int flag)

{
@@ -140,10 +140,10 @@ void tep_set_cpus(struct tep_handle *pevent, int cpus) 
}



/**

 * tep_get_long_size - get the size of a long integer on the current machine

 * tep_get_long_size - get the size of a long integer on the traced machine

 * @pevent: a handle to the tep_handle

 *

 * This returns the size of a long integer on the current machine

 * This returns the size of a long integer on the traced machine

 * If @pevent is NULL, 0 is returned.

 */

int tep_get_long_size(struct tep_handle *pevent)
@@ -154,11 +154,11 @@ int tep_get_long_size(struct tep_handle *pevent) 
}



/**

 * tep_set_long_size - set the size of a long integer on the current machine

 * tep_set_long_size - set the size of a long integer on the traced machine

 * @pevent: a handle to the tep_handle

 * @size: size, in bytes, of a long integer

 *

 * This sets the size of a long integer on the current machine

 * This sets the size of a long integer on the traced machine

 */

void tep_set_long_size(struct tep_handle *pevent, int long_size)

{
@@ -167,10 +167,10 @@ void tep_set_long_size(struct tep_handle *pevent, int long_size) 
}



/**

 * tep_get_page_size - get the size of a memory page on the current machine

 * tep_get_page_size - get the size of a memory page on the traced machine

 * @pevent: a handle to the tep_handle

 *

 * This returns the size of a memory page on the current machine

 * This returns the size of a memory page on the traced machine

 * If @pevent is NULL, 0 is returned.

 */

int tep_get_page_size(struct tep_handle *pevent)
@@ -181,11 +181,11 @@ int tep_get_page_size(struct tep_handle *pevent) 
}



/**

 * tep_set_page_size - set the size of a memory page on the current machine

 * tep_set_page_size - set the size of a memory page on the traced machine

 * @pevent: a handle to the tep_handle

 * @_page_size: size of a memory page, in bytes

 *

 * This sets the size of a memory page on the current machine

 * This sets the size of a memory page on the traced machine

 */

void tep_set_page_size(struct tep_handle *pevent, int _page_size)

{

tools/lib/traceevent/event-parse.c

+4 −2
Original line number Diff line number Diff line
@@ -6453,7 +6453,8 @@ int tep_get_any_field_val(struct trace_seq *s, struct tep_event *event, 
 * @record: The record with the field name.

 * @err: print default error if failed.

 *

 * Returns: 0 on success, -1 field not found, or 1 if buffer is full.

 * Returns positive value on success, negative in case of an error,

 * or 0 if buffer is full.

 */

int tep_print_num_field(struct trace_seq *s, const char *fmt,

			struct tep_event *event, const char *name,
@@ -6485,7 +6486,8 @@ int tep_print_num_field(struct trace_seq *s, const char *fmt, 
 * @record: The record with the field name.

 * @err: print default error if failed.

 *

 * Returns: 0 on success, -1 field not found, or 1 if buffer is full.

 * Returns positive value on success, negative in case of an error,

 * or 0 if buffer is full.

 */

int tep_print_func_field(struct trace_seq *s, const char *fmt,

			 struct tep_event *event, const char *name,

CRA Git | Maintained and supported by SUSTech CRA and CCSE