Update LTTng-modules API

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>

diff --git a/contents/reference/lttng-modules/lttng-modules-tp-fast-assign.md b/contents/reference/lttng-modules/lttng-modules-tp-fast-assign.md
deleted file mode 100644 (file)
index 7c92978..0000000
--- a/contents/reference/lttng-modules/lttng-modules-tp-fast-assign.md
+++ /dev/null
@@ -1,152 +0,0 @@
----
-id: lttng-modules-tp-fast-assign
----
-
-This table describes possible entries for the `TP_fast_assign()` part
-of `LTTNG_TRACEPOINT_EVENT()`:
-
-<div class="table">
-<table class="func-desc">
-    <thead>
-        <tr>
-            <th>Macro</th>
-            <th>Description/arguments</th>
-        </tr>
-    </thead>
-    <tbody>
-        <tr>
-            <td>
-                <ul>
-                    <li><code class="no-bg">tp_assign(<span class="arg">d</span>, <span class="arg">s</span>)</code></li>
-                </ul>
-            </td>
-            <td>
-                <p>
-                    Assignment of C expression <code class="arg">s</code>
-                    to tracepoint field <code class="arg">d</code>
-                </p>
-                <ul>
-                    <li>
-                        <code class="arg">d</code> name of destination
-                        tracepoint field
-                    </li>
-                    <li>
-                        <code class="arg">s</code> source C expression
-                        (may refer to tracepoint arguments)
-                    </li>
-                </ul>
-            </td>
-        </tr>
-        <tr>
-            <td>
-                <ul>
-                    <li><code class="no-bg">tp_memcpy(<span class="arg">d</span>, <span class="arg">s</span>, <span class="arg">l</span>)</code></li>
-                </ul>
-            </td>
-            <td>
-                <p>
-                    Memory copy of <code class="arg">l</code> bytes from
-                    <code class="arg">s</code> to tracepoint field
-                    <code class="arg">d</code> (use with array fields)
-                </p>
-                <ul>
-                    <li>
-                        <code class="arg">d</code> name of destination
-                        tracepoint field
-                    </li>
-                    <li>
-                        <code class="arg">s</code> source C expression
-                        (may refer to tracepoint arguments)
-                    </li>
-                    <li>
-                        <code class="arg">l</code> number of bytes to
-                        copy
-                    </li>
-                </ul>
-            </td>
-        </tr>
-        <tr>
-            <td>
-                <ul>
-                    <li><code class="no-bg">tp_memcpy_from_user(<span class="arg">d</span>, <span class="arg">s</span>, <span class="arg">l</span>)</code></li>
-                </ul>
-            </td>
-            <td>
-                <p>
-                    Memory copy of <code class="arg">l</code> bytes from
-                    user space <code class="arg">s</code> to tracepoint field
-                    <code class="arg">d</code> (use with array fields)
-                </p>
-                <ul>
-                    <li>
-                        <code class="arg">d</code> name of destination
-                        tracepoint field
-                    </li>
-                    <li>
-                        <code class="arg">s</code> source C expression
-                        (may refer to tracepoint arguments)
-                    </li>
-                    <li>
-                        <code class="arg">l</code> number of bytes to
-                        copy
-                    </li>
-                </ul>
-            </td>
-        </tr>
-        <tr>
-            <td>
-                <ul>
-                    <li><code class="no-bg">tp_memcpy_dyn(<span class="arg">d</span>, <span class="arg">s</span>)</code></li>
-                </ul>
-            </td>
-            <td>
-                <p>
-                    Memory copy of dynamically-sized array
-                    from <code class="arg">s</code> to tracepoint field
-                    <code class="arg">d</code>; number of bytes is
-                    known from the field's length expression (use with
-                    dynamically-sized array fields)
-                </p>
-                <ul>
-                    <li>
-                        <code class="arg">d</code> name of destination
-                        tracepoint field
-                    </li>
-                    <li>
-                        <code class="arg">s</code> source C expression
-                        (may refer to tracepoint arguments)
-                    </li>
-                    <li>
-                        <code class="arg">l</code> number of bytes to
-                        copy
-                    </li>
-                </ul>
-            </td>
-        </tr>
-        <tr>
-            <td>
-                <ul>
-                    <li><code class="no-bg">tp_strcpy(<span class="arg">d</span>, <span class="arg">s</span>)</code></li>
-                </ul>
-            </td>
-            <td>
-                <p>
-                    String copy of <code class="arg">s</code>
-                    to tracepoint field <code class="arg">d</code>
-                    (use with string fields)
-                </p>
-                <ul>
-                    <li>
-                        <code class="arg">d</code> name of destination
-                        tracepoint field
-                    </li>
-                    <li>
-                        <code class="arg">s</code> source C expression
-                        (may refer to tracepoint arguments)
-                    </li>
-                </ul>
-            </td>
-        </tr>
-    </tbody>
-</table>
-</div>

diff --git a/contents/reference/lttng-modules/lttng-modules-tp-fields.md b/contents/reference/lttng-modules/lttng-modules-tp-fields.md
new file mode 100644 (file)
index 0000000..8cad5e1
--- /dev/null
+++ b/contents/reference/lttng-modules/lttng-modules-tp-fields.md
@@ -0,0 +1,297 @@
+---
+id: lttng-modules-tp-fields
+---
+
+<a name="doc-lttng-modules-tp-fast-assign"></a>
+<a name="doc-lttng-modules-tp-struct-entry"></a>
+The available macros to define tracepoint fields, which should be listed
+within `TP_FIELDS()` in `LTTNG_TRACEPOINT_EVENT()`, are:
+
+<div class="table">
+<table class="func-desc">
+    <thead>
+        <tr>
+            <th>Macro</th>
+            <th>Description/arguments</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>
+                <ul>
+                    <li><code class="no-bg">ctf_integer(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                    <li><code class="no-bg">ctf_integer_nowrite(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                    <li><code class="no-bg">ctf_user_integer(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                    <li><code class="no-bg">ctf_user_integer_nowrite(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                </ul>
+            </td>
+            <td>
+                <p>Standard integer, displayed in base&nbsp;10</p>
+                <ul>
+                    <li>
+                        <code class="arg"><strong>t</strong></code> integer C type
+                        (<code>int</code>, <code>long</code>,
+                        <code>size_t</code>, ...)
+                    </li>
+                    <li><code class="arg"><strong>n</strong></code> field name</li>
+                    <li><code class="arg"><strong>e</strong></code> argument expression</li>
+                </ul>
+            </td>
+        </tr>
+        <tr>
+            <td>
+                <ul>
+                    <li><code class="no-bg">ctf_integer_hex(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                    <li><code class="no-bg">ctf_user_integer_hex(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                </ul>
+            </td>
+            <td>
+                <p>Standard integer, displayed in base&nbsp;16</p>
+                <ul>
+                    <li><code class="arg"><strong>t</strong></code> integer C type</li>
+                    <li><code class="arg">n</code> field name</li>
+                    <li><code class="arg">e</code> argument expression</li>
+                </ul>
+            </td>
+        </tr>
+        <tr>
+            <td><code class="no-bg">ctf_integer_oct(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></td>
+            <td>
+                <p>Standard integer, displayed in base&nbsp;8</p>
+                <ul>
+                    <li><code class="arg"><strong>t</strong></code> integer C type</li>
+                    <li><code class="arg">n</code> field name</li>
+                    <li><code class="arg">e</code> argument expression</li>
+                </ul>
+            </td>
+        </tr>
+        <tr>
+            <td>
+                <ul>
+                    <li><code class="no-bg">ctf_integer_network(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                    <li><code class="no-bg">ctf_user_integer_network(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                </ul>
+            </td>
+            <td>
+                <p>
+                    Integer in network byte order (big-endian),
+                    displayed in base&nbsp;10
+                </p>
+                <ul>
+                    <li><code class="arg">t</code> integer C type</li>
+                    <li><code class="arg">n</code> field name</li>
+                    <li><code class="arg">e</code> argument expression</li>
+                </ul>
+            </td>
+        </tr>
+        <tr>
+            <td>
+                <ul>
+                    <li><code class="no-bg">ctf_integer_network_hex(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                    <li><code class="no-bg">ctf_user_integer_network_hex(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                </ul>
+            </td>
+            <td>
+                <p>
+                    Integer in network byte order, displayed
+                    in base&nbsp;16</p>
+                <ul>
+                    <li><code class="arg">t</code> integer C type</li>
+                    <li><code class="arg">n</code> field name</li>
+                    <li><code class="arg">e</code> argument expression</li>
+                </ul>
+            </td>
+        </tr>
+        <tr>
+            <td>
+                <ul>
+                    <li><code class="no-bg">ctf_float(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                    <li><code class="no-bg">ctf_user_float(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                    <li><code class="no-bg">ctf_float_nowrite(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                    <li><code class="no-bg">ctf_user_float_nowrite(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                </ul>
+            </td>
+            <td>
+                <p>Floating point number</p>
+                <ul>
+                    <li>
+                        <code class="arg">t</code> floating point number
+                        C type (<code>float</code>, <code>double</code>)
+                    </li>
+                    <li><code class="arg">n</code> field name</li>
+                    <li><code class="arg">e</code> argument expression</li>
+                </ul>
+            </td>
+        </tr>
+        <tr>
+            <td>
+                <ul>
+                    <li><code class="no-bg">ctf_string(<span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                    <li><code class="no-bg">ctf_user_string(<span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                    <li><code class="no-bg">ctf_string_nowrite(<span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                    <li><code class="no-bg">ctf_user_string_nowrite(<span class="arg">n</span>, <span class="arg">e</span>)</code></li>
+                </ul>
+            </td>
+            <td>
+                <p>
+                    Null-terminated string; undefined behavior if
+                    <code class="arg">e</code> is <code>NULL</code>
+                </p>
+                <ul>
+                    <li><code class="arg">n</code> field name</li>
+                    <li><code class="arg">e</code> argument expression</li>
+                </ul>
+            </td>
+        </tr>
+        <tr>
+            <td>
+                <ul>
+                    <li><code class="no-bg">ctf_array(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">s</span>)</code></li>
+                    <li><code class="no-bg">ctf_user_array(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">s</span>)</code></li>
+                    <li><code class="no-bg">ctf_array_nowrite(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">s</span>)</code></li>
+                    <li><code class="no-bg">ctf_user_array_nowrite(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">s</span>)</code></li>
+                </ul>
+            </td>
+            <td>
+                <p>
+                    Statically-sized array of integers, displayed in
+                    base&nbsp;10
+                </p>
+                <ul>
+                    <li><code class="arg">t</code> array element C type</li>
+                    <li><code class="arg">n</code> field name</li>
+                    <li><code class="arg">e</code> argument expression</li>
+                    <li><code class="arg">s</code> number of elements</li>
+                </ul>
+            </td>
+        </tr>
+        <tr>
+            <td>
+                <ul>
+                    <li><code class="no-bg">ctf_array_text(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">s</span>)</code></li>
+                    <li><code class="no-bg">ctf_user_array_text(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">s</span>)</code></li>
+                    <li><code class="no-bg">ctf_array_text_nowrite(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">s</span>)</code></li>
+                    <li><code class="no-bg">ctf_user_array_text_nowrite(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">s</span>)</code></li>
+                </ul>
+            </td>
+            <td>
+                <p>
+                    Statically-sized array, printed as text; no need to
+                    be null-terminated
+                </p>
+                <ul>
+                    <li><code class="arg">t</code> array element C type (always <code>char</code>)</li>
+                    <li><code class="arg">n</code> field name</li>
+                    <li><code class="arg">e</code> argument expression</li>
+                    <li><code class="arg">s</code> number of elements</li>
+                </ul>
+            </td>
+        </tr>
+        <tr>
+            <td>
+                <ul>
+                    <li><code class="no-bg">ctf_sequence(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">T</span>, <span class="arg">E</span>)</code></li>
+                    <li><code class="no-bg">ctf_user_sequence(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">T</span>, <span class="arg">E</span>)</code></li>
+                    <li><code class="no-bg">ctf_sequence_nowrite(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">T</span>, <span class="arg">E</span>)</code></li>
+                    <li><code class="no-bg">ctf_user_sequence_nowrite(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">T</span>, <span class="arg">E</span>)</code></li>
+                </ul>
+            </td>
+            <td>
+                <p>
+                    Dynamically-sized array of integers, displayed in
+                    base&nbsp;10; type of
+                    <code class="arg">E</code> needs to be unsigned
+                </p>
+                <ul>
+                    <li><code class="arg">t</code> sequence element C type</li>
+                    <li><code class="arg">n</code> field name</li>
+                    <li><code class="arg">e</code> argument expression</li>
+                    <li><code class="arg">T</code> length expression C type</li>
+                    <li><code class="arg">E</code> length expression</li>
+                </ul>
+            </td>
+        </tr>
+        <tr>
+            <td>
+                <ul>
+                    <li><code class="no-bg">ctf_sequence_hex(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">T</span>, <span class="arg">E</span>)</code></li>
+                </ul>
+            </td>
+            <td>
+                <p>
+                    Dynamically-sized array of integers, displayed in
+                    base&nbsp;16; type of
+                    <code class="arg">E</code> needs to be unsigned
+                </p>
+                <ul>
+                    <li><code class="arg">t</code> sequence element C type</li>
+                    <li><code class="arg">n</code> field name</li>
+                    <li><code class="arg">e</code> argument expression</li>
+                    <li><code class="arg">T</code> length expression C type</li>
+                    <li><code class="arg">E</code> length expression</li>
+                </ul>
+            </td>
+        </tr>
+        <tr>
+            <td>
+                <ul>
+                    <li><code class="no-bg">ctf_sequence_network(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">T</span>, <span class="arg">E</span>)</code></li>
+                </ul>
+            </td>
+            <td>
+                <p>
+                    Dynamically-sized array of integers in network byte
+                    order (big endian), displayed in base&nbsp;10;
+                    type of
+
+
+
+                    <code class="arg">E</code> needs to be unsigned
+                </p>
+                <ul>
+                    <li><code class="arg">t</code> sequence element C type</li>
+                    <li><code class="arg">n</code> field name</li>
+                    <li><code class="arg">e</code> argument expression</li>
+                    <li><code class="arg">T</code> length expression C type</li>
+                    <li><code class="arg">E</code> length expression</li>
+                </ul>
+            </td>
+        </tr>
+        <tr>
+            <td>
+                <ul>
+                    <li><code class="no-bg">ctf_sequence_text(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">T</span>, <span class="arg">E</span>)</code></li>
+                    <li><code class="no-bg">ctf_user_sequence_text(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">T</span>, <span class="arg">E</span>)</code></li>
+                    <li><code class="no-bg">ctf_sequence_text_nowrite(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">T</span>, <span class="arg">E</span>)</code></li>
+                    <li><code class="no-bg">ctf_user_sequence_text_nowrite(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">T</span>, <span class="arg">E</span>)</code></li>
+                </ul>
+            </td>
+            <td>
+                <p>
+                    Dynamically-sized array, displayed as text; no need to
+                    be null-terminated; undefined behavior if
+                    <code class="arg">e</code> is <code>NULL</code></p>
+                <ul>
+                    <li><code class="arg">t</code> sequence element C type (always <code>char</code>)</li>
+                    <li><code class="arg">n</code> field name</li>
+                    <li><code class="arg">e</code> argument expression</li>
+                    <li><code class="arg">T</code> length expression C type</li>
+                    <li><code class="arg">E</code> length expression</li>
+                </ul>
+            </td>
+        </tr>
+    </tbody>
+</table>
+</div>
+
+The `_user` versions must be used when the argument expression, `e`, is
+a user space address. In the cases of `ctf_user_integer*()` and
+`ctf_user_float*()`, `&e` must be a user space address, thus `e` must
+be addressable.
+
+The `_nowrite` versions omit themselves from the session trace, but are
+otherwise identical. This means the `_nowrite` fields won't be written
+in the recorded trace. Their primary purpose is to make some
+of the event context available to the
+[event filters](#doc-enabling-disabling-events) without having to
+commit the data to sub-buffers.

diff --git a/contents/reference/lttng-modules/lttng-modules-tp-struct-entry.md b/contents/reference/lttng-modules/lttng-modules-tp-struct-entry.md
deleted file mode 100644 (file)
index 5f90f47..0000000
--- a/contents/reference/lttng-modules/lttng-modules-tp-struct-entry.md
+++ /dev/null
@@ -1,229 +0,0 @@
----
-id: lttng-modules-tp-struct-entry
----
-
-This table describes possible entries for the `TP_STRUCT__entry()` part
-of `LTTNG_TRACEPOINT_EVENT()`:
-
-<div class="table">
-<table class="func-desc">
-    <thead>
-        <tr>
-            <th>Macro</th>
-            <th>Description/arguments</th>
-        </tr>
-    </thead>
-    <tbody>
-        <tr>
-            <td>
-                <ul>
-                    <li><code class="no-bg">__field(<span class="arg">t</span>, <span class="arg">n</span>)</code></li>
-                </ul>
-            </td>
-            <td>
-                <p>Standard integer, displayed in base&nbsp;10</p>
-                <ul>
-                    <li>
-                        <code class="arg">t</code> integer C type
-                        (<code>int</code>, <code>unsigned char</code>,
-                        <code>size_t</code>, ...)
-                    </li>
-                    <li><code class="arg">n</code> field name</li>
-                </ul>
-            </td>
-        </tr>
-        <tr>
-            <td>
-                <ul>
-                    <li><code class="no-bg">__field_hex(<span class="arg">t</span>, <span class="arg">n</span>)</code></li>
-                </ul>
-            </td>
-            <td>
-                <p>Standard integer, displayed in base&nbsp;16</p>
-                <ul>
-                    <li><code class="arg">t</code> integer C type</li>
-                    <li><code class="arg">n</code> field name</li>
-                </ul>
-            </td>
-        </tr>
-        <tr>
-            <td>
-                <ul>
-                    <li><code class="no-bg">__field_oct(<span class="arg">t</span>, <span class="arg">n</span>)</code></li>
-                </ul>
-            </td>
-            <td>
-                <p>Standard integer, displayed in base&nbsp;8</p>
-                <ul>
-                    <li>
-                        <code class="arg">t</code> integer C type
-                    </li>
-                    <li><code class="arg">n</code> field name</li>
-                </ul>
-            </td>
-        </tr>
-        <tr>
-            <td>
-                <ul>
-                    <li><code class="no-bg">__field_network(<span class="arg">t</span>, <span class="arg">n</span>)</code></li>
-                </ul>
-            </td>
-            <td>
-                <p>
-                    Integer in network byte order (big endian),
-                    displayed in base&nbsp;10
-                </p>
-                <ul>
-                    <li>
-                        <code class="arg">t</code> integer C type
-                    </li>
-                    <li><code class="arg">n</code> field name</li>
-                </ul>
-            </td>
-        </tr>
-        <tr>
-            <td>
-                <ul>
-                    <li><code class="no-bg">__field_network_hex(<span class="arg">t</span>, <span class="arg">n</span>)</code></li>
-                </ul>
-            </td>
-            <td>
-                <p>
-                    Integer in network byte order (big endian),
-                    displayed in base&nbsp;16
-                </p>
-                <ul>
-                    <li>
-                        <code class="arg">t</code> integer C type
-                    </li>
-                    <li><code class="arg">n</code> field name</li>
-                </ul>
-            </td>
-        </tr>
-        <tr>
-            <td>
-                <ul>
-                    <li><code class="no-bg">__array(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">s</span>)</code></li>
-                </ul>
-            </td>
-            <td>
-                <p>Statically-sized array, elements displayed in base&nbsp;10</p>
-                <ul>
-                    <li>
-                        <code class="arg">t</code> array element C type
-                    </li>
-                    <li><code class="arg">n</code> field name</li>
-                    <li><code class="arg">s</code> number of elements</li>
-                </ul>
-            </td>
-        </tr>
-        <tr>
-            <td>
-                <ul>
-                    <li><code class="no-bg">__array_hex(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">s</span>)</code></li>
-                </ul>
-            </td>
-            <td>
-                <p>Statically-sized array, elements displayed in base&nbsp;16</p>
-                <ul>
-                    <li>
-                        <code class="arg">t</code> array element C type
-                    </li>
-                    <li><code class="arg">n</code> field name</li>
-                    <li><code class="arg">s</code> number of elements</li>
-                </ul>
-            </td>
-        </tr>
-        <tr>
-            <td>
-                <ul>
-                    <li><code class="no-bg">__array_text(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">s</span>)</code></li>
-                </ul>
-            </td>
-            <td>
-                <p>Statically-sized array, displayed as text</p>
-                <ul>
-                    <li>
-                        <code class="arg">t</code> array element C type
-                        (always <code>char</code>)
-                    </li>
-                    <li><code class="arg">n</code> field name</li>
-                    <li><code class="arg">s</code> number of elements</li>
-                </ul>
-            </td>
-        </tr>
-        <tr>
-            <td>
-                <ul>
-                    <li><code class="no-bg">__dynamic_array(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">s</span>)</code></li>
-                </ul>
-            </td>
-            <td>
-                <p>Dynamically-sized array, displayed in base&nbsp;10</p>
-                <ul>
-                    <li>
-                        <code class="arg">t</code> array element C type
-                    </li>
-                    <li><code class="arg">n</code> field name</li>
-                    <li><code class="arg">s</code> length C expression</li>
-                </ul>
-            </td>
-        </tr>
-        <tr>
-            <td>
-                <ul>
-                    <li><code class="no-bg">__dynamic_array_hex(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">s</span>)</code></li>
-                </ul>
-            </td>
-            <td>
-                <p>Dynamically-sized array, displayed in base&nbsp;16</p>
-                <ul>
-                    <li>
-                        <code class="arg">t</code> array element C type
-                    </li>
-                    <li><code class="arg">n</code> field name</li>
-                    <li><code class="arg">s</code> length C expression</li>
-                </ul>
-            </td>
-        </tr>
-        <tr>
-            <td>
-                <ul>
-                    <li><code class="no-bg">__dynamic_array_text(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">s</span>)</code></li>
-                </ul>
-            </td>
-            <td>
-                <p>Dynamically-sized array, displayed as text</p>
-                <ul>
-                    <li>
-                        <code class="arg">t</code> array element C type
-                        (always <code>char</code>)
-                    </li>
-                    <li><code class="arg">n</code> field name</li>
-                    <li><code class="arg">s</code> length C expression</li>
-                </ul>
-            </td>
-        </tr>
-        <tr>
-            <td>
-                <ul>
-                    <li><code class="no-bg">__string(<span class="arg">n</span>, <span class="arg">s</span>)</code></li>
-                </ul>
-            </td>
-            <td>
-                <p>
-                    Null-terminated string; undefined behavior
-                    if <code class="arg">s</code> is <code>NULL</code>
-                </p>
-                <ul>
-                    <li><code class="arg">n</code> field name</li>
-                    <li><code class="arg">s</code> string source (pointer)</li>
-                </ul>
-            </td>
-        </tr>
-    </tbody>
-</table>
-</div>
-
-The above macros should cover the majority of cases. For advanced items,
-see `probes/lttng-events.h`.

diff --git a/toc/docs.yml b/toc/docs.yml
index d6f24925e9a7aaa5704cf2ed418bcd0af9ef175d..6d817f063b10b6778aa870f5cd7c6e1ab58f2258 100644 (file)
--- a/toc/docs.yml
+++ b/toc/docs.yml
@@ -221,7 +221,5 @@ cats:
       - id: lttng-modules-ref
         title: <span class="reset-text-transform">LTTng</span>-modules
         cats:
-          - id: lttng-modules-tp-struct-entry
-            title: Tracepoint fields macros (for <code>TP_STRUCT__entry()</code>)
-          - id: lttng-modules-tp-fast-assign
-            title: Tracepoint assignment macros (for <code>TP_fast_assign()</code>)
+          - id: lttng-modules-tp-fields
+            title: Tracepoint fields macros (for <code>TP_FIELDS()</code>)