Rename the "metadata regenerate" command to "regenerate metadata"

[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 0fa240edea998f2e17a9c3af1f109d94541dc60e..53489163223ed6fa59fe4c56bf3d2020e230d9d4 100644 (file)
--- a/doc/man/lttng-metadata.1.txt
+++ b/doc/man/lttng-metadata.1.txt
@@ -15,21 +15,8 @@ SYNOPSIS
 
 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[]