public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: tip-bot for Namhyung Kim <namhyung.kim@lge.com>
To: linux-tip-commits@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, hpa@zytor.com, mingo@kernel.org,
	namhyung.kim@lge.com, namhyung@kernel.org, bp@alien8.de,
	namhyung@gmail.com, fweisbec@gmail.com, rostedt@goodmis.org,
	acme@infradead.org, dsahern@gmail.com, tglx@linutronix.de
Subject: [tip:perf/core] tools lib traceevent: Fix some comments
Date: Fri, 6 Jul 2012 04:18:14 -0700	[thread overview]
Message-ID: <tip-16e6b8fdfd181ac79f04ff826c42c7d8a2806a17@git.kernel.org> (raw)
In-Reply-To: <1335157118-14658-9-git-send-email-namhyung.kim@lge.com>

Commit-ID:  16e6b8fdfd181ac79f04ff826c42c7d8a2806a17
Gitweb:     http://git.kernel.org/tip/16e6b8fdfd181ac79f04ff826c42c7d8a2806a17
Author:     Namhyung Kim <namhyung.kim@lge.com>
AuthorDate: Mon, 23 Apr 2012 13:58:35 +0900
Committer:  Namhyung Kim <namhyung@kernel.org>
CommitDate: Wed, 4 Jul 2012 13:40:31 +0900

tools lib traceevent: Fix some comments

Update and add missing argument descriptions and fix some typo on
function comments.

Signed-off-by: Namhyung Kim <namhyung.kim@lge.com>
Cc: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Namhyung Kim <namhyung@gmail.com>
Cc: Ingo Molnar <mingo@kernel.org>
Cc: Arnaldo Carvalho de Melo <acme@infradead.org>
Cc: Borislav Petkov <bp@alien8.de>
Cc: David Ahern <dsahern@gmail.com>
Link: http://lkml.kernel.org/r/1335157118-14658-9-git-send-email-namhyung.kim@lge.com
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
Signed-off-by: Namhyung Kim <namhyung@kernel.org>
---
 tools/lib/traceevent/event-parse.c |   16 +++++++---------
 1 files changed, 7 insertions(+), 9 deletions(-)

diff --git a/tools/lib/traceevent/event-parse.c b/tools/lib/traceevent/event-parse.c
index 99b0cd4..8630160 100644
--- a/tools/lib/traceevent/event-parse.c
+++ b/tools/lib/traceevent/event-parse.c
@@ -4037,8 +4037,7 @@ static void pretty_print(struct trace_seq *s, void *data, int size, struct event
  * pevent_data_lat_fmt - parse the data for the latency format
  * @pevent: a handle to the pevent
  * @s: the trace_seq to write to
- * @data: the raw data to read from
- * @size: currently unused.
+ * @record: the record to read from
  *
  * This parses out the Latency format (interrupts disabled,
  * need rescheduling, in hard/soft interrupt, preempt count
@@ -4173,10 +4172,7 @@ const char *pevent_data_comm_from_pid(struct pevent *pevent, int pid)
  * pevent_data_comm_from_pid - parse the data into the print format
  * @s: the trace_seq to write to
  * @event: the handle to the event
- * @cpu: the cpu the event was recorded on
- * @data: the raw data
- * @size: the size of the raw data
- * @nsecs: the timestamp of the event
+ * @record: the record to read from
  *
  * This parses the raw @data using the given @event information and
  * writes the print format into the trace_seq.
@@ -4944,7 +4940,7 @@ int pevent_get_any_field_val(struct trace_seq *s, struct event_format *event,
  * @record: The record with the field name.
  * @err: print default error if failed.
  *
- * Returns: 0 on success, -1 field not fould, or 1 if buffer is full.
+ * Returns: 0 on success, -1 field not found, or 1 if buffer is full.
  */
 int pevent_print_num_field(struct trace_seq *s, const char *fmt,
 			   struct event_format *event, const char *name,
@@ -4986,11 +4982,12 @@ static void free_func_handle(struct pevent_function_handler *func)
  * pevent_register_print_function - register a helper function
  * @pevent: the handle to the pevent
  * @func: the function to process the helper function
+ * @ret_type: the return type of the helper function
  * @name: the name of the helper function
  * @parameters: A list of enum pevent_func_arg_type
  *
  * Some events may have helper functions in the print format arguments.
- * This allows a plugin to dynmically create a way to process one
+ * This allows a plugin to dynamically create a way to process one
  * of these functions.
  *
  * The @parameters is a variable list of pevent_func_arg_type enums that
@@ -5061,12 +5058,13 @@ int pevent_register_print_function(struct pevent *pevent,
 }
 
 /**
- * pevent_register_event_handle - register a way to parse an event
+ * pevent_register_event_handler - register a way to parse an event
  * @pevent: the handle to the pevent
  * @id: the id of the event to register
  * @sys_name: the system name the event belongs to
  * @event_name: the name of the event
  * @func: the function to call to parse the event information
+ * @context: the data to be passed to @func
  *
  * This function allows a developer to override the parsing of
  * a given event. If for some reason the default print format

  parent reply	other threads:[~2012-07-06 11:18 UTC|newest]

Thread overview: 38+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-04-23  4:58 [PATCH 00/11] trace-cmd: libparsevent cleanups - part 2 Namhyung Kim
2012-04-23  4:58 ` [PATCH 01/11] parse-events: Free flag/sym field on failure path Namhyung Kim
2012-04-23 16:21   ` Steven Rostedt
2012-04-24  0:05     ` Namhyung Kim
2012-04-24  1:07       ` [PATCH v2] " Namhyung Kim
2012-04-23  4:58 ` [PATCH 02/11] parse-events: Fix freeing arg on process_dynamic_array() Namhyung Kim
2012-04-23 16:34   ` Steven Rostedt
2012-04-23  4:58 ` [PATCH 03/11] parse-events: Get rid of handling concatenation on event_read_print Namhyung Kim
2012-04-23 16:33   ` Steven Rostedt
2012-04-24  0:09     ` Namhyung Kim
2012-04-24  0:26       ` Steven Rostedt
2012-04-23  4:58 ` [PATCH 04/11] parse-events: Remove unused arg->dynarray.index Namhyung Kim
2012-04-23 18:35   ` Steven Rostedt
2012-04-23  4:58 ` [PATCH 05/11] parse-events: Use proper function parameter type Namhyung Kim
2012-04-23 18:38   ` Steven Rostedt
2012-04-23  4:58 ` [PATCH 06/11] parse-events: Pass string type argument to args Namhyung Kim
2012-04-23 18:41   ` Steven Rostedt
2012-07-06 11:16   ` [tip:perf/core] tools lib traceevent: " tip-bot for Namhyung Kim
2012-04-23  4:58 ` [PATCH 07/11] parse-events: Do not call add_event() again if allocation failed Namhyung Kim
2012-04-23 18:43   ` Steven Rostedt
2012-07-06 11:17   ` [tip:perf/core] tools lib traceevent: " tip-bot for Namhyung Kim
2012-04-23  4:58 ` [PATCH 08/11] parse-events: Fix some comments Namhyung Kim
2012-04-23 18:47   ` Steven Rostedt
2012-07-06 11:18   ` tip-bot for Namhyung Kim [this message]
2012-04-23  4:58 ` [PATCH 09/11] parse-filter: Check result of malloc() during reading token Namhyung Kim
2012-04-23 18:48   ` Steven Rostedt
2012-04-24  0:15     ` Namhyung Kim
2012-07-06 11:19   ` [tip:perf/core] tools lib traceevent: " tip-bot for Namhyung Kim
2012-04-23  4:58 ` [PATCH 10/11] parse-filter: Fix signature of create_arg_item() Namhyung Kim
2012-04-23 18:57   ` Steven Rostedt
2012-04-23  4:58 ` [PATCH 11/11] parse-filter: Check return value of arg_to_str() Namhyung Kim
2012-04-23 18:59   ` Steven Rostedt
2012-07-06 11:20   ` [tip:perf/core] tools lib traceevent: " tip-bot for Namhyung Kim
2012-04-24  1:29 ` [PATCH 12/11] parse-events: Cleanup realloc use Namhyung Kim
2012-05-15  8:39   ` Namhyung Kim
2012-05-15  8:48     ` Steven Rostedt
2012-05-15  9:32       ` Namhyung Kim
2012-07-06 11:21   ` [tip:perf/core] tools lib traceevent: " tip-bot for Namhyung Kim

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=tip-16e6b8fdfd181ac79f04ff826c42c7d8a2806a17@git.kernel.org \
    --to=namhyung.kim@lge.com \
    --cc=acme@infradead.org \
    --cc=bp@alien8.de \
    --cc=dsahern@gmail.com \
    --cc=fweisbec@gmail.com \
    --cc=hpa@zytor.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-tip-commits@vger.kernel.org \
    --cc=mingo@kernel.org \
    --cc=namhyung@gmail.com \
    --cc=namhyung@kernel.org \
    --cc=rostedt@goodmis.org \
    --cc=tglx@linutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox