doc/man: use specific revision date for each manual page
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Fri, 18 Oct 2019 19:53:05 +0000 (15:53 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Fri, 18 Oct 2019 20:53:11 +0000 (16:53 -0400)
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
<https://tdg.docbook.org/tdg/4.5/refentryinfo.html> and
<https://tdg.docbook.org/tdg/4.5/date.html>).

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 <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
30 files changed:
doc/man/asciidoc.conf
doc/man/lttng-add-context.1.txt
doc/man/lttng-crash.1.txt
doc/man/lttng-create.1.txt
doc/man/lttng-destroy.1.txt
doc/man/lttng-disable-channel.1.txt
doc/man/lttng-disable-event.1.txt
doc/man/lttng-disable-rotation.1.txt
doc/man/lttng-enable-channel.1.txt
doc/man/lttng-enable-event.1.txt
doc/man/lttng-enable-rotation.1.txt
doc/man/lttng-help.1.txt
doc/man/lttng-list.1.txt
doc/man/lttng-load.1.txt
doc/man/lttng-metadata.1.txt
doc/man/lttng-regenerate.1.txt
doc/man/lttng-relayd.8.txt
doc/man/lttng-rotate.1.txt
doc/man/lttng-save.1.txt
doc/man/lttng-sessiond.8.txt
doc/man/lttng-set-session.1.txt
doc/man/lttng-snapshot.1.txt
doc/man/lttng-start.1.txt
doc/man/lttng-status.1.txt
doc/man/lttng-stop.1.txt
doc/man/lttng-track.1.txt
doc/man/lttng-untrack.1.txt
doc/man/lttng-version.1.txt
doc/man/lttng-view.1.txt
doc/man/lttng.1.txt

index 6fc2d5e09f4bbf7c6d513d278103fca4d517b259..a961db21a845522963495004712327787d5e52c9 100644 (file)
@@ -129,16 +129,19 @@ ifdef::backend-docbook[]
 [header]
 template::[header-declarations]
 <refentry>
-<refmeta>
-<refentrytitle>{mantitle}</refentrytitle>
-<manvolnum>{manvolnum}</manvolnum>
-<refmiscinfo class="source">LTTng</refmiscinfo>
-<refmiscinfo class="version">{lttng_version}</refmiscinfo>
-<refmiscinfo class="manual">LTTng Manual</refmiscinfo>
-</refmeta>
-<refnamediv>
-  <refname>{manname}</refname>
-  <refpurpose>{manpurpose}</refpurpose>
-</refnamediv>
+    <refentryinfo>
+        <date>{revdate}</date>
+    </refentryinfo>
+    <refmeta>
+        <refentrytitle>{mantitle}</refentrytitle>
+        <manvolnum>{manvolnum}</manvolnum>
+        <refmiscinfo class="source">LTTng</refmiscinfo>
+        <refmiscinfo class="version">{lttng_version}</refmiscinfo>
+        <refmiscinfo class="manual">LTTng Manual</refmiscinfo>
+    </refmeta>
+    <refnamediv>
+        <refname>{manname}</refname>
+        <refpurpose>{manpurpose}</refpurpose>
+    </refnamediv>
 endif::backend-docbook[]
 endif::doctype-manpage[]
index a026452db22b5ecabb3a2721f4c73e14aa59491f..640da1db1309dda5c81c466dc78a994e01cacc41 100644 (file)
@@ -1,5 +1,6 @@
 lttng-add-context(1)
 ====================
+:revdate: 5 Februrary 2018
 
 
 NAME
index b3982d039fa4ebe3741c6a90c8ebbdfa6edc14f7..25483847d13b5886c4225540170f945ccda2af07 100644 (file)
@@ -1,5 +1,6 @@
 lttng-crash(1)
 ==============
+:revdate: 5 June 2018
 
 
 NAME
index 35c6345608f035c10aca5c59864e73cbbad1581f..d61918d6a3ce1784e428f1826c0cb1c7fffaf494 100644 (file)
@@ -1,5 +1,6 @@
 lttng-create(1)
 ===============
+:revdate: 18 January 2018
 
 
 NAME
index 1e7ecade209124078a0ed020222a3cb865602aa7..e68ad77ae0d6bd10895eb3da58327b610e169282 100644 (file)
@@ -1,5 +1,6 @@
 lttng-destroy(1)
-===============
+================
+:revdate: 18 January 2018
 
 
 NAME
index d3fe61e8145701a2357a766e52d5c81162a80f1b..ccfb1a9fa7e1135e680a8804401044b467b9a1f5 100644 (file)
@@ -1,6 +1,6 @@
 lttng-disable-channel(1)
-=======================
-
+========================
+:revdate: 28 November 2016
 
 NAME
 ----
index 595706eb3ace8701872cf36d169ed8b1a0c15778..096d921b10e12427d2e03db5c43730f0ace22e1a 100644 (file)
@@ -1,5 +1,6 @@
 lttng-disable-event(1)
 ======================
+:revdate: 28 November 2016
 
 
 NAME
index 5c79abba3da4efb68f784c8c0e2339a9bc918467..ef03c0befe828b45b5f52e70977cf22a312244e8 100644 (file)
@@ -1,5 +1,6 @@
 lttng-disable-rotation(1)
 =========================
+:revdate: 8 November 2018
 
 
 NAME
index f3328648af4cbc0859ca3ea92c11b8d357d241cc..7ddbe48b4416deb017e003aa9e7370ff62edf5f1 100644 (file)
@@ -1,5 +1,6 @@
 lttng-enable-channel(1)
 =======================
+:revdate: 9 November 2018
 
 
 NAME
index ceb533bd10492f8958ed7b6f9ed2b4506aa25861..18df67d465acd9fafe5faff4763e107f9ee134f6 100644 (file)
@@ -1,5 +1,6 @@
 lttng-enable-event(1)
 =====================
+:revdate: 4 April 2019
 
 
 NAME
index e8970cd97b64187eac8b3ad8647bfd8d2073477c..a002085aa6c24e528bb3367f37d9dfe8d5981f3f 100644 (file)
@@ -1,5 +1,6 @@
 lttng-enable-rotation(1)
 ========================
+:revdate: 13 November 2018
 
 
 NAME
index ede7b88f4d866586e49e6973ebf48189d454800c..65b909dd9a8b9cd444b397a06303af57a489d699 100644 (file)
@@ -1,5 +1,6 @@
 lttng-help(1)
 =============
+:revdate: 14 March 2017
 
 
 NAME
index 95025563920993ca64d160c58266cb2346943dac..0cb19fe4825cd8f0582c3d0110243f6bb2379b88 100644 (file)
@@ -1,5 +1,6 @@
 lttng-list(1)
 =============
+:revdate: 28 November 2016
 
 
 NAME
index d68ae5bd715305f5a1da3a700e479ab4f8da0357..691437dd743811fe6f8a7606deb4c295c5e37531 100644 (file)
@@ -1,5 +1,6 @@
 lttng-load(1)
 =============
+:revdate: 28 November 2016
 
 
 NAME
index 7b292880ecab00d068bc57af83e4cbe67ea92ee0..5d9864be7c9842a98e47c01279c5021eaddb0fc0 100644 (file)
@@ -1,5 +1,6 @@
 lttng-metadata(1)
 =================
+:revdate: 28 November 2016
 
 
 NAME
index 2b19515018133126323ce7cae879e9452a269507..a220551884e192e477e2c588f87164efe1e585b5 100644 (file)
@@ -1,5 +1,6 @@
 lttng-regenerate(1)
-=================
+===================
+:revdate: 18 January 2018
 
 
 NAME
index 6a1f0bee229ce31c3dd5c0b8991f58613a4ec89b..2f41ec29bfae082b84ea0ccc5b3aa2961d41f918 100644 (file)
@@ -1,5 +1,6 @@
 lttng-relayd(8)
 ===============
+:revdate: 5 June 2018
 
 
 NAME
index d197b877b9b8476af17c85140839231109a76c04..c582126bd6a14137cdda0fde8c83942a6d72c86b 100644 (file)
@@ -1,5 +1,6 @@
 lttng-rotate(1)
 ===============
+:revdate: 18 October 2019
 
 
 NAME
index 5346262ee419af3803fcf5407aa47c77a9e59485..6bb607f4f3169da2ba3748ef6c737e7d36ddb255 100644 (file)
@@ -1,5 +1,6 @@
 lttng-save(1)
 =============
+:revdate: 28 November 2016
 
 
 NAME
index b0fa4920776abd80460f73d4e74b9bbbe84748da..73a9717c591c86ae0511796b5cb301ad912ae0e7 100644 (file)
@@ -1,5 +1,6 @@
 lttng-sessiond(8)
 =================
+:revdate: 17 September 2018
 
 
 NAME
index d9c041cf404ba9602b450463e57ecb7602312ad5..068a66f336e1ef40249369075ae85ccbfdca6648 100644 (file)
@@ -1,5 +1,6 @@
 lttng-set-session(1)
 ====================
+:revdate: 7 April 2016
 
 
 NAME
index 9d5b313a8e4ac230fea1a8da15437be530eba1ef..d60d6fcef0aaba6e24885dc546225b031fb6e5e8 100644 (file)
@@ -1,5 +1,6 @@
 lttng-snapshot(1)
 =================
+:revdate: 9 November 2018
 
 
 NAME
index 541c4aedee71d8927377017e1cb396efb2061c84..a6868f16077c778e38d0d816df98b82b74a6a33e 100644 (file)
@@ -1,5 +1,6 @@
 lttng-start(1)
 ==============
+:revdate: 7 April 2016
 
 
 NAME
index 2fa7b47edd9db5b1ffa078f4854d916cb6c3cd2d..05e5bc5503dbf2a5e7fd13d2193bffb1971c5ddd 100644 (file)
@@ -1,5 +1,6 @@
 lttng-status(1)
 ===============
+:revdate: 14 March 2017
 
 
 NAME
index aafde32d88f0663e0a03fa6529523cbe4b7d87b5..55afcd3483345ffbc27c9f85b75812305f1e8929 100644 (file)
@@ -1,5 +1,6 @@
 lttng-stop(1)
 =============
+:revdate: 18 January 2018
 
 
 NAME
index de8e7ec9d484591a9450f4156d9c24cc2bc8002d..d8c3812928a246ee792e02e6dc2ed69ad4566899 100644 (file)
@@ -1,5 +1,6 @@
 lttng-track(1)
 ==============
+:revdate: 14 March 2017
 
 
 NAME
index 3fb02558db45df4e00f3fd78cd77c408a5cecc0d..8d0fd1f60ae837a993dea87191e010a259bbe6fb 100644 (file)
@@ -1,5 +1,6 @@
 lttng-untrack(1)
 ================
+:revdate: 14 March 2017
 
 
 NAME
index bc824f5330b7035e3e9cbd3863f43ee799a54d53..dce553c8beb3329248706818d2442ac4eb24e914 100644 (file)
@@ -1,5 +1,6 @@
 lttng-version(1)
 ================
+:revdate: 1 May 2018
 
 
 NAME
index 86d62536b8d38ceac342ce72a5f7a607db23c2d4..50dc129d3182782a08ca35b9a10372c77ac4916d 100644 (file)
@@ -1,5 +1,6 @@
 lttng-view(1)
 =============
+:revdate: 28 November 2016
 
 
 NAME
index bcd2407625f60543da17691e4a08bca3263110ff..4e02c765b20e1bdafc1747f0800b7c137837867b 100644 (file)
@@ -1,5 +1,6 @@
 lttng(1)
 ========
+:revdate: 16 October 2019
 
 
 NAME
This page took 0.048802 seconds and 4 git commands to generate.