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:56:27 +0000 (16:56 -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>
27 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-enable-channel.1.txt
doc/man/lttng-enable-event.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-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 ed697b83b620d436593de6d250aaa6c8387fb3c4..e22ffc8f5059351c059d5e0d55d1a8c37ef291f4 100644 (file)
@@ -116,16 +116,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 7c3ebcea64da0cf5ed88756e2b641c1ccbd6ea71..2c7b48003e3ba88086e5b4a4c07abc8e7293202b 100644 (file)
@@ -1,5 +1,6 @@
 lttng-crash(1)
 ==============
+:revdate: 5 June 2018
 
 
 NAME
index 152e3f39364ee8f5e8795fa8baf2bbcb3feb4ba5..909a36736b6c1410cd2cf475a89c394ba92f5b77 100644 (file)
@@ -1,5 +1,6 @@
 lttng-create(1)
 ===============
+:revdate: 18 January 2018
 
 
 NAME
index 4b3f4f00e213989aa74d51f4b15f14a1463d575d..2da9551838867d4eff92862c26dc14a1d33a8e71 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 787666ad5d1969d3f23598f1015c631443a8a99e..cbd1a5b11e6609490e17193f9d63d87323ceb625 100644 (file)
@@ -1,5 +1,6 @@
 lttng-enable-channel(1)
 =======================
+:revdate: 9 November 2018
 
 
 NAME
index 92fd5f51f22d65910f951edbed665cfed84df63d..2f571e621ba8b2330858d7b99fc89a5245c889b1 100644 (file)
@@ -1,5 +1,6 @@
 lttng-enable-event(1)
 =====================
+:revdate: 4 April 2019
 
 
 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 fd306ad8099f766b084a99d7e456a68ed52d4123..f16d8585cfe0ba435fc8f14451b1ebe8508b7917 100644 (file)
@@ -1,5 +1,6 @@
 lttng-regenerate(1)
-=================
+===================
+:revdate: 18 January 2018
 
 
 NAME
index a4ac4343122eb31a60b9712db20fb7e21f4d3169..60aef01e51ddc5a4678d4fe1a6f55ef32f4db12c 100644 (file)
@@ -1,5 +1,6 @@
 lttng-relayd(8)
 ===============
+:revdate: 5 June 2018
 
 
 NAME
index 5346262ee419af3803fcf5407aa47c77a9e59485..6bb607f4f3169da2ba3748ef6c737e7d36ddb255 100644 (file)
@@ -1,5 +1,6 @@
 lttng-save(1)
 =============
+:revdate: 28 November 2016
 
 
 NAME
index 2d07329efa44cb0b73f73d771f091ebbfcf375d9..b27148a0e0d1851a40ac9133f569e0feb7f58a98 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 ac4bebfd756355b9c9a7f80857de162a42128b45..99edef55f378ab5542a32a5b7524971f20a1d9f7 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 8e71529df14ee805583b64a5270db02b9f5309d3..e1915724c57b045db9f501c4e73c872c15404fea 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 faa14c58e0f6ebb9c26b4f8b436f0a8024fd0141..738a0ada66926855d5ea973351ee25575b36044e 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 9ff407094b79190df063efe29ef8bd9c213fb55f..7a6bf61aab0f2e545acc09268077bf64c6fd08b7 100644 (file)
@@ -1,5 +1,6 @@
 lttng(1)
 ========
+:revdate: 16 October 2019
 
 
 NAME
This page took 0.03676 seconds and 4 git commands to generate.