All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Tzvetomir Stoyanov (VMware)" <tz.stoyanov@gmail.com>
To: rostedt@goodmis.org
Cc: linux-trace-devel@vger.kernel.org
Subject: [PATCH 4/4] libtracefs: tracefs_iterate_raw_events() documentation update
Date: Tue,  6 Apr 2021 07:20:01 +0300	[thread overview]
Message-ID: <20210406042001.912544-5-tz.stoyanov@gmail.com> (raw)
In-Reply-To: <20210406042001.912544-1-tz.stoyanov@gmail.com>

Updated the man page of tracefs_iterate_raw_events() API:
 - Fixed a typo in the function name.
 - Added a new sentence, describing the iteration in sorted order.

Signed-off-by: Tzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com>
---
 Documentation/libtracefs-events.txt | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/Documentation/libtracefs-events.txt b/Documentation/libtracefs-events.txt
index 9608a12..78c9834 100644
--- a/Documentation/libtracefs-events.txt
+++ b/Documentation/libtracefs-events.txt
@@ -37,14 +37,14 @@ local machine, or it may be a path to a copy of the tracefs directory
 from another machine. The last entry in the array as a NULL pointer.
 The array must be freed with _tracefs_list_free()_ API.
 
-The _tracefs_interate_raw_events()_ function will read the tracefs raw
+The _tracefs_iterate_raw_events()_ function will read the tracefs raw
 data buffers and call the specified _callback_ function for every event it
-encounters. An initialized _tep_ handler is required (See
-_tracefs_local_events_(3)). If _instance_ is NULL, then the toplevel
-tracefs buffer is used, otherwise the buffer for the corresponding
-_instance_ is read. To filter only on a subset of CPUs, _cpus_ and
-_cpu_size_ may be set to only call _callback_ with events that occurred on
-the CPUs specified, otherwise if _cpus_ is NULL then the _callback_
+encounters. Events are iterated in sorted order: oldest first. An initialized
+_tep_ handler is required (See _tracefs_local_events_(3)). If _instance_ is
+NULL, then the toplevel tracefs buffer is used, otherwise the buffer for
+the corresponding _instance_ is read. To filter only on a subset of CPUs,
+_cpus_ and _cpu_size_ may be set to only call _callback_ with events that
+occurred on the CPUs specified, otherwise if _cpus_ is NULL then the _callback_
 function will be called for all events, and _cpu_size_ is ignored. The
 _callback_ function will be called with the following parameters: A
 pointer to a struct tep_event that corresponds to the type of event the
-- 
2.30.2


      parent reply	other threads:[~2021-04-06  4:20 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-06  4:19 [PATCH 0/4] Iterate over raw events in sorted order Tzvetomir Stoyanov (VMware)
2021-04-06  4:19 ` [PATCH 1/4] libtracefs: " Tzvetomir Stoyanov (VMware)
2021-04-06 16:01   ` Steven Rostedt
2021-04-06  4:19 ` [PATCH 2/4] libtracefs: Unit test for iterate " Tzvetomir Stoyanov (VMware)
2021-04-06  4:20 ` [PATCH 3/4] libtracefs: Unit test for iterate over raw events in selected CPUs Tzvetomir Stoyanov (VMware)
2021-04-06  4:20 ` Tzvetomir Stoyanov (VMware) [this message]

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=20210406042001.912544-5-tz.stoyanov@gmail.com \
    --to=tz.stoyanov@gmail.com \
    --cc=linux-trace-devel@vger.kernel.org \
    --cc=rostedt@goodmis.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.