docs: Correct typos in the tutorial v0.2
authorKienan Stewart <kstewart@efficios.com>
Wed, 16 Oct 2024 17:17:13 +0000 (13:17 -0400)
committerKienan Stewart <kstewart@efficios.com>
Wed, 16 Oct 2024 17:17:13 +0000 (13:17 -0400)
Signed-off-by: Kienan Stewart <kstewart@efficios.com>
doc/tutorial.md

index e79631d11051eaed52a478c322cfd795e56cdba8..33d94e14dce4cb224d3bfe53d0ef6a0a447b047b 100644 (file)
@@ -6,7 +6,7 @@ SPDX-License-Identifier: MIT
 
 # Tutorial
 
-This tutorial shows how to compile the Exatracer and use it for testing on a HIP
+This tutorial shows how to compile the Exatracer and use it for testing a HIP
 hello world program.
 
 # User program
@@ -104,16 +104,16 @@ TRACE_OUTPUT=my-traces
 # Create an LTTng session and dump the trace to `my-traces' directory.
 lttng create --output $TRACE_OUTPUT
 
-# Enable all event defined by the Exatracer.  For every public function of HIP,
+# Enable all events defined by the Exatracer.  For every public function of HIP,
 # HSA there are two events.  `enter' and `exit'.  For every public function of
 # ROC-TX, there is a single event.
 #
 # All events have some context information, like timestamp, hostname and CPU ID.
 #
-# A `enter' event has all the arguments passed to the function, plus a pair of
+# An `enter' event has all the arguments passed to the function, plus a pair of
 # IDs that when concatenated, forms a unique ID in the trace.
 #
-# A `exit' event only has the corresponding pair of IDs to do correlation with
+# An `exit' event only has the corresponding pair of IDs to do correlation with
 # the `enter' event.
 lttng enable-event --userspace 'hsa:*'
 lttng enable-event --userspace 'hip:*'
@@ -123,8 +123,8 @@ lttng enable-event --userspace 'roctx:*'
 lttng start
 
 # The application is executed with the Exatracer LD_PRELOAD onto it.  This
-# assumes that `libextracer.so' can be found by the dynamic loader.  See
-# ld-linux(8).
+# assumes that `libexatracer.so' can be found by the dynamic loader.  See
+# ld-linux(8) for more information.
 LD_PRELOAD=libexatracer.so ./hello-world
 
 # When done, the tracing session can be destroyed to flush all pending events.
@@ -161,14 +161,11 @@ The output from Babeltrace should look like this:
 [12:35:27.404342780] (+0.000001610) HOST hip:hipDeviceSynchronize_exit: { cpu_id = 11 }, { lttng_thread_id = 0, lttng_local_id = 8, lttng_has_ret = 1, lttng_ret = 0 }
 ```
 
-Each line represents an event.  Events are printed in chronolical order.  The
-anatomy of a event is like so: 
+Each line represents an event.  Events are printed in chronological order.  The
+anatomy of a event is like so:
 
 `[TIMESTAMP] (PREVIOUS-DIFF) HOSTNAME PROVIDER:EVENT_NAME CONTEXT ... { FIELDS ... }`
 
 Refer to the [Babeltrace
 documentation](https://babeltrace.org/docs/v2.0/man1/babeltrace2-convert.1/) for
 interpreting the events.
-
-
-
This page took 0.025225 seconds and 4 git commands to generate.