diff options
author | Namhyung Kim <namhyung.kim@lge.com> | 2012-04-23 00:58:35 -0400 |
---|---|---|
committer | Namhyung Kim <namhyung@kernel.org> | 2012-07-04 00:40:31 -0400 |
commit | 16e6b8fdfd181ac79f04ff826c42c7d8a2806a17 (patch) | |
tree | 377b48f825945275d13031b512dc593631c5d9ca /tools/lib | |
parent | 4b5632bc3122ec9b7e875294c8abe92f1573196a (diff) |
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>
Diffstat (limited to 'tools/lib')
-rw-r--r-- | 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 99b0cd4b79d4..863016040dd6 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 | |||
4037 | * pevent_data_lat_fmt - parse the data for the latency format | 4037 | * pevent_data_lat_fmt - parse the data for the latency format |
4038 | * @pevent: a handle to the pevent | 4038 | * @pevent: a handle to the pevent |
4039 | * @s: the trace_seq to write to | 4039 | * @s: the trace_seq to write to |
4040 | * @data: the raw data to read from | 4040 | * @record: the record to read from |
4041 | * @size: currently unused. | ||
4042 | * | 4041 | * |
4043 | * This parses out the Latency format (interrupts disabled, | 4042 | * This parses out the Latency format (interrupts disabled, |
4044 | * need rescheduling, in hard/soft interrupt, preempt count | 4043 | * need rescheduling, in hard/soft interrupt, preempt count |
@@ -4173,10 +4172,7 @@ const char *pevent_data_comm_from_pid(struct pevent *pevent, int pid) | |||
4173 | * pevent_data_comm_from_pid - parse the data into the print format | 4172 | * pevent_data_comm_from_pid - parse the data into the print format |
4174 | * @s: the trace_seq to write to | 4173 | * @s: the trace_seq to write to |
4175 | * @event: the handle to the event | 4174 | * @event: the handle to the event |
4176 | * @cpu: the cpu the event was recorded on | 4175 | * @record: the record to read from |
4177 | * @data: the raw data | ||
4178 | * @size: the size of the raw data | ||
4179 | * @nsecs: the timestamp of the event | ||
4180 | * | 4176 | * |
4181 | * This parses the raw @data using the given @event information and | 4177 | * This parses the raw @data using the given @event information and |
4182 | * writes the print format into the trace_seq. | 4178 | * 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, | |||
4944 | * @record: The record with the field name. | 4940 | * @record: The record with the field name. |
4945 | * @err: print default error if failed. | 4941 | * @err: print default error if failed. |
4946 | * | 4942 | * |
4947 | * Returns: 0 on success, -1 field not fould, or 1 if buffer is full. | 4943 | * Returns: 0 on success, -1 field not found, or 1 if buffer is full. |
4948 | */ | 4944 | */ |
4949 | int pevent_print_num_field(struct trace_seq *s, const char *fmt, | 4945 | int pevent_print_num_field(struct trace_seq *s, const char *fmt, |
4950 | struct event_format *event, const char *name, | 4946 | struct event_format *event, const char *name, |
@@ -4986,11 +4982,12 @@ static void free_func_handle(struct pevent_function_handler *func) | |||
4986 | * pevent_register_print_function - register a helper function | 4982 | * pevent_register_print_function - register a helper function |
4987 | * @pevent: the handle to the pevent | 4983 | * @pevent: the handle to the pevent |
4988 | * @func: the function to process the helper function | 4984 | * @func: the function to process the helper function |
4985 | * @ret_type: the return type of the helper function | ||
4989 | * @name: the name of the helper function | 4986 | * @name: the name of the helper function |
4990 | * @parameters: A list of enum pevent_func_arg_type | 4987 | * @parameters: A list of enum pevent_func_arg_type |
4991 | * | 4988 | * |
4992 | * Some events may have helper functions in the print format arguments. | 4989 | * Some events may have helper functions in the print format arguments. |
4993 | * This allows a plugin to dynmically create a way to process one | 4990 | * This allows a plugin to dynamically create a way to process one |
4994 | * of these functions. | 4991 | * of these functions. |
4995 | * | 4992 | * |
4996 | * The @parameters is a variable list of pevent_func_arg_type enums that | 4993 | * 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, | |||
5061 | } | 5058 | } |
5062 | 5059 | ||
5063 | /** | 5060 | /** |
5064 | * pevent_register_event_handle - register a way to parse an event | 5061 | * pevent_register_event_handler - register a way to parse an event |
5065 | * @pevent: the handle to the pevent | 5062 | * @pevent: the handle to the pevent |
5066 | * @id: the id of the event to register | 5063 | * @id: the id of the event to register |
5067 | * @sys_name: the system name the event belongs to | 5064 | * @sys_name: the system name the event belongs to |
5068 | * @event_name: the name of the event | 5065 | * @event_name: the name of the event |
5069 | * @func: the function to call to parse the event information | 5066 | * @func: the function to call to parse the event information |
5067 | * @context: the data to be passed to @func | ||
5070 | * | 5068 | * |
5071 | * This function allows a developer to override the parsing of | 5069 | * This function allows a developer to override the parsing of |
5072 | * a given event. If for some reason the default print format | 5070 | * a given event. If for some reason the default print format |