From 990cbf5236222caf3a1fdfa2e2bfeb63dec1e631 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Fri, 18 Oct 2019 15:53:05 -0400 Subject: [PATCH] doc/man: use specific revision date for each manual page MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit This patch makes each manual page indicate its own revision date with the `revdate` AsciiDoc attribute. In `asciidoc.conf`, we use this attribute to specify the DocBook reference page date (see and ). Without the DocBook date tag, `xmlto` uses the current date. You can see this date at the bottom of the rendered manual page: ... SEE ALSO lttng-enable-rotation(1), lttng-disable-rotation(1), lttng(1) LTTng 2.12.0-pre 10/18/2019 LTTNG-ROTATE(1) Using the manual page generation date seems unexpected for the reader here. For this initial change, I used the last commit date for each source file. Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- doc/man/asciidoc.conf | 25 ++++++++++++++----------- doc/man/lttng-add-context.1.txt | 1 + doc/man/lttng-crash.1.txt | 1 + doc/man/lttng-create.1.txt | 1 + doc/man/lttng-destroy.1.txt | 3 ++- doc/man/lttng-disable-channel.1.txt | 4 ++-- doc/man/lttng-disable-event.1.txt | 1 + doc/man/lttng-enable-channel.1.txt | 1 + doc/man/lttng-enable-event.1.txt | 1 + doc/man/lttng-help.1.txt | 1 + doc/man/lttng-list.1.txt | 1 + doc/man/lttng-load.1.txt | 1 + doc/man/lttng-metadata.1.txt | 1 + doc/man/lttng-regenerate.1.txt | 3 ++- doc/man/lttng-relayd.8.txt | 1 + doc/man/lttng-save.1.txt | 1 + doc/man/lttng-sessiond.8.txt | 1 + doc/man/lttng-set-session.1.txt | 1 + doc/man/lttng-snapshot.1.txt | 1 + doc/man/lttng-start.1.txt | 1 + doc/man/lttng-status.1.txt | 1 + doc/man/lttng-stop.1.txt | 1 + doc/man/lttng-track.1.txt | 1 + doc/man/lttng-untrack.1.txt | 1 + doc/man/lttng-version.1.txt | 1 + doc/man/lttng-view.1.txt | 1 + doc/man/lttng.1.txt | 1 + 27 files changed, 43 insertions(+), 15 deletions(-) diff --git a/doc/man/asciidoc.conf b/doc/man/asciidoc.conf index ed697b83b..e22ffc8f5 100644 --- a/doc/man/asciidoc.conf +++ b/doc/man/asciidoc.conf @@ -116,16 +116,19 @@ ifdef::backend-docbook[] [header] template::[header-declarations] - -{mantitle} -{manvolnum} -LTTng -{lttng_version} -LTTng Manual - - - {manname} - {manpurpose} - + + {revdate} + + + {mantitle} + {manvolnum} + LTTng + {lttng_version} + LTTng Manual + + + {manname} + {manpurpose} + endif::backend-docbook[] endif::doctype-manpage[] diff --git a/doc/man/lttng-add-context.1.txt b/doc/man/lttng-add-context.1.txt index a026452db..640da1db1 100644 --- a/doc/man/lttng-add-context.1.txt +++ b/doc/man/lttng-add-context.1.txt @@ -1,5 +1,6 @@ lttng-add-context(1) ==================== +:revdate: 5 Februrary 2018 NAME diff --git a/doc/man/lttng-crash.1.txt b/doc/man/lttng-crash.1.txt index 7c3ebcea6..2c7b48003 100644 --- a/doc/man/lttng-crash.1.txt +++ b/doc/man/lttng-crash.1.txt @@ -1,5 +1,6 @@ lttng-crash(1) ============== +:revdate: 5 June 2018 NAME diff --git a/doc/man/lttng-create.1.txt b/doc/man/lttng-create.1.txt index 152e3f393..909a36736 100644 --- a/doc/man/lttng-create.1.txt +++ b/doc/man/lttng-create.1.txt @@ -1,5 +1,6 @@ lttng-create(1) =============== +:revdate: 18 January 2018 NAME diff --git a/doc/man/lttng-destroy.1.txt b/doc/man/lttng-destroy.1.txt index 4b3f4f00e..2da955183 100644 --- a/doc/man/lttng-destroy.1.txt +++ b/doc/man/lttng-destroy.1.txt @@ -1,5 +1,6 @@ lttng-destroy(1) -=============== +================ +:revdate: 18 January 2018 NAME diff --git a/doc/man/lttng-disable-channel.1.txt b/doc/man/lttng-disable-channel.1.txt index d3fe61e81..ccfb1a9fa 100644 --- a/doc/man/lttng-disable-channel.1.txt +++ b/doc/man/lttng-disable-channel.1.txt @@ -1,6 +1,6 @@ lttng-disable-channel(1) -======================= - +======================== +:revdate: 28 November 2016 NAME ---- diff --git a/doc/man/lttng-disable-event.1.txt b/doc/man/lttng-disable-event.1.txt index 595706eb3..096d921b1 100644 --- a/doc/man/lttng-disable-event.1.txt +++ b/doc/man/lttng-disable-event.1.txt @@ -1,5 +1,6 @@ lttng-disable-event(1) ====================== +:revdate: 28 November 2016 NAME diff --git a/doc/man/lttng-enable-channel.1.txt b/doc/man/lttng-enable-channel.1.txt index 787666ad5..cbd1a5b11 100644 --- a/doc/man/lttng-enable-channel.1.txt +++ b/doc/man/lttng-enable-channel.1.txt @@ -1,5 +1,6 @@ lttng-enable-channel(1) ======================= +:revdate: 9 November 2018 NAME diff --git a/doc/man/lttng-enable-event.1.txt b/doc/man/lttng-enable-event.1.txt index 92fd5f51f..2f571e621 100644 --- a/doc/man/lttng-enable-event.1.txt +++ b/doc/man/lttng-enable-event.1.txt @@ -1,5 +1,6 @@ lttng-enable-event(1) ===================== +:revdate: 4 April 2019 NAME diff --git a/doc/man/lttng-help.1.txt b/doc/man/lttng-help.1.txt index ede7b88f4..65b909dd9 100644 --- a/doc/man/lttng-help.1.txt +++ b/doc/man/lttng-help.1.txt @@ -1,5 +1,6 @@ lttng-help(1) ============= +:revdate: 14 March 2017 NAME diff --git a/doc/man/lttng-list.1.txt b/doc/man/lttng-list.1.txt index 950255639..0cb19fe48 100644 --- a/doc/man/lttng-list.1.txt +++ b/doc/man/lttng-list.1.txt @@ -1,5 +1,6 @@ lttng-list(1) ============= +:revdate: 28 November 2016 NAME diff --git a/doc/man/lttng-load.1.txt b/doc/man/lttng-load.1.txt index d68ae5bd7..691437dd7 100644 --- a/doc/man/lttng-load.1.txt +++ b/doc/man/lttng-load.1.txt @@ -1,5 +1,6 @@ lttng-load(1) ============= +:revdate: 28 November 2016 NAME diff --git a/doc/man/lttng-metadata.1.txt b/doc/man/lttng-metadata.1.txt index 7b292880e..5d9864be7 100644 --- a/doc/man/lttng-metadata.1.txt +++ b/doc/man/lttng-metadata.1.txt @@ -1,5 +1,6 @@ lttng-metadata(1) ================= +:revdate: 28 November 2016 NAME diff --git a/doc/man/lttng-regenerate.1.txt b/doc/man/lttng-regenerate.1.txt index fd306ad80..f16d8585c 100644 --- a/doc/man/lttng-regenerate.1.txt +++ b/doc/man/lttng-regenerate.1.txt @@ -1,5 +1,6 @@ lttng-regenerate(1) -================= +=================== +:revdate: 18 January 2018 NAME diff --git a/doc/man/lttng-relayd.8.txt b/doc/man/lttng-relayd.8.txt index a4ac43431..60aef01e5 100644 --- a/doc/man/lttng-relayd.8.txt +++ b/doc/man/lttng-relayd.8.txt @@ -1,5 +1,6 @@ lttng-relayd(8) =============== +:revdate: 5 June 2018 NAME diff --git a/doc/man/lttng-save.1.txt b/doc/man/lttng-save.1.txt index 5346262ee..6bb607f4f 100644 --- a/doc/man/lttng-save.1.txt +++ b/doc/man/lttng-save.1.txt @@ -1,5 +1,6 @@ lttng-save(1) ============= +:revdate: 28 November 2016 NAME diff --git a/doc/man/lttng-sessiond.8.txt b/doc/man/lttng-sessiond.8.txt index 2d07329ef..b27148a0e 100644 --- a/doc/man/lttng-sessiond.8.txt +++ b/doc/man/lttng-sessiond.8.txt @@ -1,5 +1,6 @@ lttng-sessiond(8) ================= +:revdate: 17 September 2018 NAME diff --git a/doc/man/lttng-set-session.1.txt b/doc/man/lttng-set-session.1.txt index d9c041cf4..068a66f33 100644 --- a/doc/man/lttng-set-session.1.txt +++ b/doc/man/lttng-set-session.1.txt @@ -1,5 +1,6 @@ lttng-set-session(1) ==================== +:revdate: 7 April 2016 NAME diff --git a/doc/man/lttng-snapshot.1.txt b/doc/man/lttng-snapshot.1.txt index ac4bebfd7..99edef55f 100644 --- a/doc/man/lttng-snapshot.1.txt +++ b/doc/man/lttng-snapshot.1.txt @@ -1,5 +1,6 @@ lttng-snapshot(1) ================= +:revdate: 9 November 2018 NAME diff --git a/doc/man/lttng-start.1.txt b/doc/man/lttng-start.1.txt index 541c4aede..a6868f160 100644 --- a/doc/man/lttng-start.1.txt +++ b/doc/man/lttng-start.1.txt @@ -1,5 +1,6 @@ lttng-start(1) ============== +:revdate: 7 April 2016 NAME diff --git a/doc/man/lttng-status.1.txt b/doc/man/lttng-status.1.txt index 2fa7b47ed..05e5bc550 100644 --- a/doc/man/lttng-status.1.txt +++ b/doc/man/lttng-status.1.txt @@ -1,5 +1,6 @@ lttng-status(1) =============== +:revdate: 14 March 2017 NAME diff --git a/doc/man/lttng-stop.1.txt b/doc/man/lttng-stop.1.txt index 8e71529df..e1915724c 100644 --- a/doc/man/lttng-stop.1.txt +++ b/doc/man/lttng-stop.1.txt @@ -1,5 +1,6 @@ lttng-stop(1) ============= +:revdate: 18 January 2018 NAME diff --git a/doc/man/lttng-track.1.txt b/doc/man/lttng-track.1.txt index de8e7ec9d..d8c381292 100644 --- a/doc/man/lttng-track.1.txt +++ b/doc/man/lttng-track.1.txt @@ -1,5 +1,6 @@ lttng-track(1) ============== +:revdate: 14 March 2017 NAME diff --git a/doc/man/lttng-untrack.1.txt b/doc/man/lttng-untrack.1.txt index 3fb02558d..8d0fd1f60 100644 --- a/doc/man/lttng-untrack.1.txt +++ b/doc/man/lttng-untrack.1.txt @@ -1,5 +1,6 @@ lttng-untrack(1) ================ +:revdate: 14 March 2017 NAME diff --git a/doc/man/lttng-version.1.txt b/doc/man/lttng-version.1.txt index faa14c58e..738a0ada6 100644 --- a/doc/man/lttng-version.1.txt +++ b/doc/man/lttng-version.1.txt @@ -1,5 +1,6 @@ lttng-version(1) ================ +:revdate: 1 May 2018 NAME diff --git a/doc/man/lttng-view.1.txt b/doc/man/lttng-view.1.txt index 86d62536b..50dc129d3 100644 --- a/doc/man/lttng-view.1.txt +++ b/doc/man/lttng-view.1.txt @@ -1,5 +1,6 @@ lttng-view(1) ============= +:revdate: 28 November 2016 NAME diff --git a/doc/man/lttng.1.txt b/doc/man/lttng.1.txt index 9ff407094..7a6bf61aa 100644 --- a/doc/man/lttng.1.txt +++ b/doc/man/lttng.1.txt @@ -1,5 +1,6 @@ lttng(1) ======== +:revdate: 16 October 2019 NAME -- 2.34.1