All of lore.kernel.org
 help / color / mirror / Atom feed
From: Deepak R Varma <drv@mailo.com>
To: linux-kernel@vger.kernel.org, rostedt@goodmis.org
Cc: linux-kernel-mentees@lists.linuxfoundation.org,
	ivan.orlov0322@gmail.com, skhan@linuxfoundation.org,
	Deepak R Varma <drv@mailo.com>
Subject: [PATCH] tracing: Fix minor typos in samples header
Date: Fri, 15 Sep 2023 02:59:02 +0530	[thread overview]
Message-ID: <ZQN7HiaghPYu4sAl@runicha.com> (raw)

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@mailo.com>
---
 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




             reply	other threads:[~2023-09-14 21:29 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-09-14 21:29 Deepak R Varma [this message]
2023-10-06 20:31 ` [PATCH] tracing: Fix minor typos in samples header Deepak R Varma
2023-10-06 20:31   ` Deepak R Varma

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=ZQN7HiaghPYu4sAl@runicha.com \
    --to=drv@mailo.com \
    --cc=ivan.orlov0322@gmail.com \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rostedt@goodmis.org \
    --cc=skhan@linuxfoundation.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.