Fix: Mark ASCIIDOC_ATTRS_CONF as a dependency of man page targets
[lttng-tools.git] / doc / man / lttng-metadata.1.txt
index a146c93243d6c32b51b3472f222ea6ac8ba66e46..53489163223ed6fa59fe4c56bf3d2020e230d9d4 100644 (file)
@@ -10,26 +10,13 @@ lttng-metadata - Manage an LTTng tracing session's metadata generation
 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.
-
-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.
+WARNING: This command is **deprecated**; it has been replaced by the *lttng
+regenerate metadata* command (see man:lttng-regenerate(1)).
 
 
 include::common-cmd-options-head.txt[]
@@ -49,8 +36,8 @@ 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
+See man:lttng-enable-channel(1) for more information about
+buffering schemes and man:lttng-create(1) for more information
 about the different tracing session modes.
 
 
@@ -59,4 +46,4 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng(1)
+man:lttng(1)
This page took 0.023809 seconds and 4 git commands to generate.