tracing: update comments to match event code macros

Impact: clean up / comments

The comments that described the ftrace macros to manipulate the
TRACE_EVENT and TRACE_FORMAT macros no longer match the code.
This patch updates them.

Reported-by: KOSAKI Motohiro <kosaki.motohiro@jp.fujitsu.com>
Signed-off-by: Steven Rostedt <srostedt@redhat.com>

diff --git a/kernel/trace/trace_events_stage_1.h b/kernel/trace/trace_events_stage_1.h
index 82f68443c556456ce95dc767bdfb0d1a0d80e274..38985f9b379c4b4037d24095c3dafb19b3213117 100644 (file)
--- a/kernel/trace/trace_events_stage_1.h
+++ b/kernel/trace/trace_events_stage_1.h
@@ -6,11 +6,13 @@
  * struct ftrace_raw_<call> {
  *     struct trace_entry              ent;
  *     <type>                          <item>;
+ *     <type2>                         <item2>[<len>];
  *     [...]
  * };
  *
- * The <type> <item> is created by the TRACE_FIELD(type, item, assign)
- * macro. We simply do "type item;", and that will create the fields
+ * The <type> <item> is created by the __field(type, item) macro or
+ * the __array(type2, item2, len) macro.
+ * We simply do "type item;", and that will create the fields
  * in the structure.
  */
 

diff --git a/kernel/trace/trace_events_stage_2.h b/kernel/trace/trace_events_stage_2.h
index 1ad9f8d2fe45d3fd2b4818aa5dc45e4b4651018a..ca347afd6aa038ff05be1479e787a17ea1c17765 100644 (file)
--- a/kernel/trace/trace_events_stage_2.h
+++ b/kernel/trace/trace_events_stage_2.h
@@ -20,7 +20,7 @@
  *
  *     field = (typeof(field))entry;
  *
- *     ret = trace_seq_printf(s, <TP_RAW_FMT> "%s", <ARGS> "\n");
+ *     ret = trace_seq_printf(s, <TP_printk> "\n");
  *     if (!ret)
  *             return TRACE_TYPE_PARTIAL_LINE;
  *
@@ -76,10 +76,9 @@ ftrace_raw_output_##call(struct trace_iterator *iter, int flags)     \
  *     int ret;
  *
  *     ret = trace_seq_printf(s, #type " " #item ";"
- *                            " size:%d; offset:%d;\n",
- *                            sizeof(field.type),
- *                            offsetof(struct ftrace_raw_##call,
- *                                     item));
+ *                            " offset:%u; size:%u;\n",
+ *                            offsetof(struct ftrace_raw_##call, item),
+ *                            sizeof(field.type));
  *
  * }
  */

diff --git a/kernel/trace/trace_events_stage_3.h b/kernel/trace/trace_events_stage_3.h
index d6de06b9201a29e59cdb66b7af6c8bf58b45db5f..6ee1de59f19d4608f5050dd1eee018f1ac60fb78 100644 (file)
--- a/kernel/trace/trace_events_stage_3.h
+++ b/kernel/trace/trace_events_stage_3.h
@@ -56,7 +56,8 @@
  *             return;
  *     entry   = ring_buffer_event_data(event);
  *
- *     <tstruct>;  <-- Here we assign the entries by the TRACE_FIELD.
+ *     <assign>;  <-- Here we assign the entries by the __field and
+ *                     __array macros.
  *
  *     trace_current_buffer_unlock_commit(event, irq_flags, pc);
  * }
@@ -96,11 +97,10 @@
  * __attribute__((__aligned__(4)))
  * __attribute__((section("_ftrace_events"))) event_<call> = {
  *     .name                   = "<call>",
+ *     .system                 = "<system>",
+ *     .raw_init               = ftrace_raw_init_event_<call>,
  *     .regfunc                = ftrace_reg_event_<call>,
  *     .unregfunc              = ftrace_unreg_event_<call>,
- *     .raw_init               = ftrace_raw_init_event_<call>,
- *     .raw_reg                = ftrace_raw_reg_event_<call>,
- *     .raw_unreg              = ftrace_raw_unreg_event_<call>,
  *     .show_format            = ftrace_format_<call>,
  * }
  *