Rename "tracing session" -> "recording session"

[lttng-tools.git] / doc / man / lttng-metadata.1.txt

diff --git a/doc/man/lttng-metadata.1.txt b/doc/man/lttng-metadata.1.txt
index a146c93243d6c32b51b3472f222ea6ac8ba66e46..b4f1c401b0e7678588d608c541e605a2980cb209 100644 (file)
--- a/doc/man/lttng-metadata.1.txt
+++ b/doc/man/lttng-metadata.1.txt
@@ -1,62 +1,46 @@
 lttng-metadata(1)
 =================
+:revdate: 14 June 2021
 
 
 NAME
 ----
-lttng-metadata - Manage an LTTng tracing session's metadata generation
+lttng-metadata - Manage the metadata generation of an LTTng recording session
 
 
 SYNOPSIS
 --------
 [verse]
-*lttng* ['GENERAL OPTIONS'] *metadata regenerate* [option:--session='SESSION']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *metadata* *regenerate* [option:--session='SESSION']
 
 
 DESCRIPTION
 -----------
-The `lttng metadata` command manages a tracing session's metadata
-generation options.
+WARNING: This command is **deprecated**; it's been replaced with
+`lttng regenerate metadata` (see man:lttng-regenerate(1)).
 
-As of this version, only the `regenerate` command's action is available.
-Regenerating a tracing session's metadata can be used to
-resample the offset between the system's monotonic clock and
-the wall-clock time.
 
-This command is meant to be used to resample the wall-clock time
-following a major
-link:https://en.wikipedia.org/wiki/Network_Time_Protocol[NTP]
-correction. As such, a system booting with an incorrect wall time can be
-traced before its wall time is NTP-corrected. Regenerating the tracing
-session's metadata ensures that trace viewers can accurately determine
-the events time relative to Unix Epoch.
+include::common-lttng-cmd-options-head.txt[]
 
 
-include::common-cmd-options-head.txt[]
+option:-s 'SESSION', option:--session='SESSION'::
+    Manage the metadata generation of the recording session named
+    'SESSION' instead of the current recording session (see
+    man:lttng-concepts(7) to learn more about the current recording
+    session).
 
 
-option:-s, option:--session='SESSION'::
-    Manage the metadata generation of the tracing session named 'SESSION'
-    instead of the current tracing session.
+include::common-lttng-cmd-help-options.txt[]
 
 
-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-after-options.txt[]
 
 
-LIMITATIONS
------------
-The `lttng metadata regenerate` command can only be used on kernel and
-user space tracing sessions (using per-user buffering), in non-live
-mode.
-
-See linklttng:lttng-enable-channel(1) for more information about
-buffering schemes and linklttng:lttng-create(1) for more information
-about the different tracing session modes.
-
-
-include::common-cmd-footer.txt[]
+include::common-footer.txt[]
 
 
 SEE ALSO
 --------
-linklttng:lttng(1)
+man:lttng(1),
+man:lttng-regenerate(1),
+man:lttng-concepts(7)