[PATCH] tracing: Fix minor typos in samples header

From: Deepak R Varma
Date: Thu Sep 14 2023 - 17:29:10 EST


Following minor corrections in the comments section of the trace
events sample header file.

- There are 6 parts of the TRACE_EVENT macro instead of 5 (name,
TP_PROTO, TP_ARGS, TP_STRUCT, TP_fast_assign, TP_printk).

- The example variable for __field_struct type should be the
variable name instead of the variable.

- Improve closing brace alignment to improve readability.

Signed-off-by: Deepak R Varma <drv@xxxxxxxxx>
---
samples/trace_events/trace-events-sample.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/samples/trace_events/trace-events-sample.h b/samples/trace_events/trace-events-sample.h
index 1c6b843b8c4e..551ecad212c8 100644
--- a/samples/trace_events/trace-events-sample.h
+++ b/samples/trace_events/trace-events-sample.h
@@ -61,7 +61,7 @@
#include <linux/tracepoint.h>

/*
- * The TRACE_EVENT macro is broken up into 5 parts.
+ * The TRACE_EVENT macro is broken up into 6 parts.
*
* name: name of the trace point. This is also how to enable the tracepoint.
* A function called trace_foo_bar() will be created.
@@ -93,7 +93,7 @@
*
* __field_struct(struct bar, foo)
*
- * __entry->bar.x = y;
+ * __entry->foo.x = y;

* __array: There are three fields (type, name, size). The type is the
* type of elements in the array, the name is the name of the array.
@@ -410,7 +410,7 @@ TRACE_EVENT_CONDITION(foo_bar_with_cond,

TP_STRUCT__entry(
__string( foo, foo )
- __field( int, bar )
+ __field( int, bar )
),

TP_fast_assign(
--
2.39.2