> On Mar 15, 2019, at 1:11 AM, Tzvetomir Stoyanov <tstoyanov@xxxxxxxxxx> wrote: > > 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() and > tep_set_page_size(). > > Signed-off-by: Tzvetomir Stoyanov <tstoyanov@xxxxxxxxxx> > --- > tools/lib/traceevent/event-parse-api.c | 21 ++++++++++++--------- > tools/lib/traceevent/event-parse.c | 4 ++-- > 2 files changed, 14 insertions(+), 11 deletions(-) > > diff --git a/tools/lib/traceevent/event-parse-api.c b/tools/lib/traceevent/event-parse-api.c > index d4368dcc16ea..2d5d3642e3e9 100644 > --- a/tools/lib/traceevent/event-parse-api.c > +++ b/tools/lib/traceevent/event-parse-api.c > @@ -100,10 +100,10 @@ tep_data2host8(struct tep_handle *pevent, unsigned long long data) > } > > /** > - * tep_get_header_page_size - get size of the header page > + * tep_get_header_page_size - get the size of a long integer, in kernel context Just want to check If this comment change correct. Given the function name it looks a bit odd compared to the comment for tep_get_long_size(). > * @pevent: a handle to the tep_handle > * > - * This returns size of the header page > + * This returns the size of a long integer, in kernel context > * If @pevent is NULL, 0 is returned. > */ > int tep_get_header_page_size(struct tep_handle *pevent) > @@ -140,10 +140,11 @@ 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 machine, > + * where the trace is generated > * If @pevent is NULL, 0 is returned. > */
|