X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-metadata.1.txt;h=220225b31be8b8ae07dc8194340bdba013e33a31;hb=26f0c7794376456fcb5b13d4eae91c0ccf0dfe66;hp=dfe3d54e447cce790957d13d4b6929e72df40d1f;hpb=ce19b9ed9bd9591bd0c4d1998780082a490991fd;p=lttng-tools.git diff --git a/doc/man/lttng-metadata.1.txt b/doc/man/lttng-metadata.1.txt index dfe3d54e4..220225b31 100644 --- a/doc/man/lttng-metadata.1.txt +++ b/doc/man/lttng-metadata.1.txt @@ -1,62 +1,43 @@ lttng-metadata(1) ================= +:revdate: 30 April 2021 NAME ---- -lttng-metadata - Manage an LTTng tracing session's metadata generation +lttng-metadata - Manage the metadata generation of an LTTng tracing session SYNOPSIS -------- [verse] -*lttng* ['linkgenoptions:(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's been replaced with +`lttng regenerate metadata` (see man:lttng-regenerate(1)). include::common-cmd-options-head.txt[] -option:-s, option:--session='SESSION':: - Manage the metadata generation of the tracing session named 'SESSION' - instead of the current tracing session. +option:-s 'SESSION', option:--session='SESSION':: + Manage the metadata generation of the tracing session named + 'SESSION' instead of the current tracing session (see + man:lttng-concepts(7) to learn more about the current tracing + session). include::common-cmd-help-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[] SEE ALSO -------- -linklttng:lttng(1) +man:lttng(1), +man:lttng-concepts(7), +man:lttng-regenerate(1)