examples/linux-fs-simple: convert README to Asciidoctor and improve it
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Thu, 17 Sep 2020 04:05:44 +0000 (00:05 -0400)
committerPhilippe Proulx <eeppeliteloop@gmail.com>
Thu, 17 Sep 2020 13:28:36 +0000 (09:28 -0400)
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
examples/linux-fs-simple/README.adoc [new file with mode: 0644]
examples/linux-fs-simple/README.md [deleted file]

diff --git a/examples/linux-fs-simple/README.adoc b/examples/linux-fs-simple/README.adoc
new file mode 100644 (file)
index 0000000..32c95a0
--- /dev/null
@@ -0,0 +1,50 @@
+// Render with Asciidoctor
+
+= Linux FS simple example
+Philippe Proulx
+16 September 2020
+:toc: left
+
+This simple example shows how to use the barectf
+link:../../../platforms/linux-fs[Linux FS platform].
+
+== Build
+
+Make sure barectf is installed.
+
+Build this example:
+
+----
+$ make
+----
+
+== Run
+
+Run this example:
+
+----
+$ ./linux-fs-simple
+----
+
+The complete CTF trace is the `ctf` directory.
+
+[NOTE]
+====
+You can run the example with arguments; they will be recorded as string
+fields in the event records of the `ctf/stream` data stream.
+
+For example:
+
+----
+$ ./linux-fs-simple dolore excepteur eiusmod commodo incididunt
+----
+====
+
+== Read
+
+Read the resulting trace with
+https://babeltrace.org/[Babeltrace{nbsp}2]:
+
+----
+$ babeltrace2 ctf
+----
diff --git a/examples/linux-fs-simple/README.md b/examples/linux-fs-simple/README.md
deleted file mode 100644 (file)
index 705bf21..0000000
+++ /dev/null
@@ -1,27 +0,0 @@
-# linux-fs-simple example
-
-This very simple example shows how to use the barectf
-[linux-fs platform](../../../platforms/linux-fs).
-
-
-## Building
-
-Make sure you have the latest version of barectf installed.
-
-Build this example:
-
-    make
-
-
-## Running
-
-Run this example:
-
-    ./linux-fs-simple
-
-The complete CTF trace is written to the `ctf` directory.
-
-You may run the example with any arguments; they will be recorded,
-as string fields in the events of the binary stream, e.g.:
-
-    ./linux-fs-simple this argument and this one will be recorded
This page took 0.023924 seconds and 4 git commands to generate.