From d2cb6c956b4abbb562c90b0fa5ab4970efb3bb91 Mon Sep 17 00:00:00 2001
From: Ben Pfaff <blp@nicira.com>
Date: Wed, 2 Jan 2013 10:19:14 -0800
Subject: [PATCH] manpages: Put version number instead of date at bottom of
 page.

We're really good about keeping manpages up to date, but terrible at
updating the dates at the bottom of the manpages.  So, instead of using
manually updated dates, this commit switches to using automatically updated
version numbers.

We can only use automatically updated version numbers for manpages that
we preprocess, that is, the manpages whose sources end with ".in".  This
excludes a couple of manpages that don't actually get installed with OVS,
such as the manpages for ovs-ctl and ovsdb-idlc.  This commit doesn't
change those manpages.  It does change the ovs-bugtool manpage to one that
is preprocessed so that we can use the version there.

Signed-off-by: Ben Pfaff <blp@nicira.com>
Acked-by: Ethan Jackson <ethan@nicira.com>
---
 ovsdb/ovsdb-client.1.in                               | 2 +-
 ovsdb/ovsdb-doc.in                                    | 4 ++--
 ovsdb/ovsdb-server.1.in                               | 2 +-
 ovsdb/ovsdb-tool.1.in                                 | 2 +-
 utilities/bugtool/automake.mk                         | 4 +++-
 utilities/bugtool/{ovs-bugtool.8 => ovs-bugtool.8.in} | 2 +-
 utilities/ovs-appctl.8.in                             | 2 +-
 utilities/ovs-benchmark.1.in                          | 2 +-
 utilities/ovs-controller.8.in                         | 2 +-
 utilities/ovs-dpctl.8.in                              | 2 +-
 utilities/ovs-l3ping.8.in                             | 2 +-
 utilities/ovs-ofctl.8.in                              | 2 +-
 utilities/ovs-pcap.1.in                               | 2 +-
 utilities/ovs-pki.8.in                                | 2 +-
 utilities/ovs-tcpundump.1.in                          | 2 +-
 utilities/ovs-test.8.in                               | 4 ++--
 utilities/ovs-vlan-bug-workaround.8.in                | 2 +-
 utilities/ovs-vlan-test.8.in                          | 2 +-
 utilities/ovs-vsctl.8.in                              | 2 +-
 vswitchd/ovs-vswitchd.8.in                            | 2 +-
 20 files changed, 24 insertions(+), 22 deletions(-)
 rename utilities/bugtool/{ovs-bugtool.8 => ovs-bugtool.8.in} (95%)

diff --git a/ovsdb/ovsdb-client.1.in b/ovsdb/ovsdb-client.1.in
index a813478f7..53f357918 100644
--- a/ovsdb/ovsdb-client.1.in
+++ b/ovsdb/ovsdb-client.1.in
@@ -5,7 +5,7 @@
 .  IP "\\$1"
 ..
 .\" -*- nroff -*-
-.TH ovsdb\-client 1 "November 2009" "Open vSwitch" "Open vSwitch Manual"
+.TH ovsdb\-client 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .\" This program's name:
 .ds PN ovsdb\-client
 .\" SSL peer program's name:
diff --git a/ovsdb/ovsdb-doc.in b/ovsdb/ovsdb-doc.in
index 40749ccec..aa4fae2e6 100755
--- a/ovsdb/ovsdb-doc.in
+++ b/ovsdb/ovsdb-doc.in
@@ -265,7 +265,7 @@ def docsToNroff(schemaFile, xmlFile, erFile, title=None):
     # Putting '\" p as the first line tells "man" that the manpage
     # needs to be preprocessed by "pic".
     s = r''''\" p
-.TH %s 5 "%s" "Open vSwitch" "Open vSwitch Manual"
+.TH @VERSION@ 5 "%s" "Open vSwitch" "Open vSwitch Manual"
 .\" -*- nroff -*-
 .de TQ
 .  br
@@ -281,7 +281,7 @@ def docsToNroff(schemaFile, xmlFile, erFile, title=None):
 .SH NAME
 %s \- %s database schema
 .PP
-''' % (title, d.strftime("%B %Y"), textToNroff(title), schema.name)
+''' % (title, textToNroff(title), schema.name)
 
     tables = ""
     introNodes = []
diff --git a/ovsdb/ovsdb-server.1.in b/ovsdb/ovsdb-server.1.in
index 242c98b54..9d424715f 100644
--- a/ovsdb/ovsdb-server.1.in
+++ b/ovsdb/ovsdb-server.1.in
@@ -1,5 +1,5 @@
 .\" -*- nroff -*-
-.TH ovsdb\-server 1 "November 2009" "Open vSwitch" "Open vSwitch Manual"
+.TH ovsdb\-server 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .\" This program's name:
 .ds PN ovsdb\-server
 .\" SSL peer program's name:
diff --git a/ovsdb/ovsdb-tool.1.in b/ovsdb/ovsdb-tool.1.in
index f9a36610b..a2f1f22ba 100644
--- a/ovsdb/ovsdb-tool.1.in
+++ b/ovsdb/ovsdb-tool.1.in
@@ -5,7 +5,7 @@
 .  IP "\\$1"
 ..
 .\" -*- nroff -*-
-.TH ovsdb\-tool 1 "November 2009" "Open vSwitch" "Open vSwitch Manual"
+.TH ovsdb\-tool 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .ds PN ovsdb\-tool
 .
 .SH NAME
diff --git a/utilities/bugtool/automake.mk b/utilities/bugtool/automake.mk
index cd422aa4b..30dac491f 100644
--- a/utilities/bugtool/automake.mk
+++ b/utilities/bugtool/automake.mk
@@ -1,8 +1,10 @@
 if HAVE_PYTHON
 sbin_SCRIPTS += utilities/bugtool/ovs-bugtool
 CLEANFILES += utilities/bugtool/ovs-bugtool
+
 man_MANS += utilities/bugtool/ovs-bugtool.8
-MAN_ROOTS += utilities/bugtool/ovs-bugtool.8
+MAN_ROOTS += utilities/bugtool/ovs-bugtool.8.in
+DISTCLEANFILES += utilities/bugtool/ovs-ofctl.8
 
 bugtool_plugins = \
 	utilities/bugtool/plugins/kernel-info/openvswitch.xml \
diff --git a/utilities/bugtool/ovs-bugtool.8 b/utilities/bugtool/ovs-bugtool.8.in
similarity index 95%
rename from utilities/bugtool/ovs-bugtool.8
rename to utilities/bugtool/ovs-bugtool.8.in
index 18a8395a8..a1e653be2 100644
--- a/utilities/bugtool/ovs-bugtool.8
+++ b/utilities/bugtool/ovs-bugtool.8.in
@@ -4,7 +4,7 @@
 .  ns
 .  IP "\\$1"
 ..
-.TH ovs\-bugtool 8 "June 2011" "Open vSwitch" "Open vSwitch Manual"
+.TH ovs\-bugtool 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .\" This program's name:
 .ds PN ovs\-bugtool
 .
diff --git a/utilities/ovs-appctl.8.in b/utilities/ovs-appctl.8.in
index 7edd18234..df5630978 100644
--- a/utilities/ovs-appctl.8.in
+++ b/utilities/ovs-appctl.8.in
@@ -4,7 +4,7 @@
 .  ns
 .  IP "\\$1"
 ..
-.TH ovs\-appctl 8 "November 2009" "Open vSwitch" "Open vSwitch Manual"
+.TH ovs\-appctl 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .ds PN ovs\-appctl
 .
 .SH NAME
diff --git a/utilities/ovs-benchmark.1.in b/utilities/ovs-benchmark.1.in
index 1183fe8cb..97e9d3264 100644
--- a/utilities/ovs-benchmark.1.in
+++ b/utilities/ovs-benchmark.1.in
@@ -1,6 +1,6 @@
 .\" -*- nroff -*-
 .so lib/ovs.tmac
-.TH ovs\-benchmark 1 "July 2011" "Open vSwitch" "Open vSwitch Manual"
+.TH ovs\-benchmark 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .
 .SH NAME
 ovs\-benchmark \- flow setup benchmark utility for Open vSwitch
diff --git a/utilities/ovs-controller.8.in b/utilities/ovs-controller.8.in
index d07ca1b4c..162c585dd 100644
--- a/utilities/ovs-controller.8.in
+++ b/utilities/ovs-controller.8.in
@@ -4,7 +4,7 @@
 .  ns
 .  IP "\\$1"
 ..
-.TH ovs\-controller 8 "March 2009" "Open vSwitch" "Open vSwitch Manual"
+.TH ovs\-controller 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .ds PN ovs\-controller
 .
 .SH NAME
diff --git a/utilities/ovs-dpctl.8.in b/utilities/ovs-dpctl.8.in
index 32362e5ed..b1b257086 100644
--- a/utilities/ovs-dpctl.8.in
+++ b/utilities/ovs-dpctl.8.in
@@ -3,7 +3,7 @@
 .  ns
 .  IP "\\$1"
 ..
-.TH ovs\-dpctl 8 "August 2009" "Open vSwitch" "Open vSwitch Manual"
+.TH ovs\-dpctl 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .ds PN ovs\-dpctl
 .
 .SH NAME
diff --git a/utilities/ovs-l3ping.8.in b/utilities/ovs-l3ping.8.in
index d3ce3cb51..d6a3f948a 100644
--- a/utilities/ovs-l3ping.8.in
+++ b/utilities/ovs-l3ping.8.in
@@ -3,7 +3,7 @@
 .  ns
 .  IP "\\$1"
 ..
-.TH ovs\-l3ping 1 "June 2012" "Open vSwitch" "Open vSwitch Manual"
+.TH ovs\-l3ping 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .
 .SH NAME
 \fBovs\-l3ping\fR \- check network deployment for L3 tunneling
diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in
index 9608c528f..906d280ed 100644
--- a/utilities/ovs-ofctl.8.in
+++ b/utilities/ovs-ofctl.8.in
@@ -4,7 +4,7 @@
 .  ns
 .  IP "\\$1"
 ..
-.TH ovs\-ofctl 8 "January 2011" "Open vSwitch" "Open vSwitch Manual"
+.TH ovs\-ofctl 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .ds PN ovs\-ofctl
 .
 .SH NAME
diff --git a/utilities/ovs-pcap.1.in b/utilities/ovs-pcap.1.in
index b36bbe70d..8f794be8f 100644
--- a/utilities/ovs-pcap.1.in
+++ b/utilities/ovs-pcap.1.in
@@ -1,4 +1,4 @@
-.TH ovs\-pcap 1 "December 2010" "Open vSwitch" "Open vSwitch Manual"
+.TH ovs\-pcap 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .
 .SH NAME
 ovs\-pcap \- print packets from a pcap file as hex
diff --git a/utilities/ovs-pki.8.in b/utilities/ovs-pki.8.in
index e2aa5b4dd..6d042b48b 100644
--- a/utilities/ovs-pki.8.in
+++ b/utilities/ovs-pki.8.in
@@ -3,7 +3,7 @@
 .  ns
 .  IP "\\$1"
 ..
-.TH ovs\-pki 8 "May 2008" "Open vSwitch" "Open vSwitch Manual"
+.TH ovs\-pki 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 
 .SH NAME
 ovs\-pki \- OpenFlow public key infrastructure management utility
diff --git a/utilities/ovs-tcpundump.1.in b/utilities/ovs-tcpundump.1.in
index ce12e820b..133c04231 100644
--- a/utilities/ovs-tcpundump.1.in
+++ b/utilities/ovs-tcpundump.1.in
@@ -1,4 +1,4 @@
-.TH ovs\-tcpundump 1 "December 2010" "Open vSwitch" "Open vSwitch Manual"
+.TH ovs\-tcpundump 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .
 .SH NAME
 ovs\-tcpundump \- convert ``tcpdump \-xx'' output to hex strings
diff --git a/utilities/ovs-test.8.in b/utilities/ovs-test.8.in
index 9704f72df..1126b3cb2 100644
--- a/utilities/ovs-test.8.in
+++ b/utilities/ovs-test.8.in
@@ -3,7 +3,7 @@
 .  ns
 .  IP "\\$1"
 ..
-.TH ovs\-test 1 "April 2012" "Open vSwitch" "Open vSwitch Manual"
+.TH ovs\-test 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .
 .SH NAME
 \fBovs\-test\fR \- check Linux drivers for performance, vlan and L3 tunneling
@@ -141,4 +141,4 @@ GRE tests between both nodes:
 .BR ovs\-vsctl (8),
 .BR ovs\-vlan\-test (8),
 .BR ethtool (8),
-.BR uname (1)
\ No newline at end of file
+.BR uname (1)
diff --git a/utilities/ovs-vlan-bug-workaround.8.in b/utilities/ovs-vlan-bug-workaround.8.in
index d05fe938b..51ea4abda 100644
--- a/utilities/ovs-vlan-bug-workaround.8.in
+++ b/utilities/ovs-vlan-bug-workaround.8.in
@@ -4,7 +4,7 @@
 .  ns
 .  IP "\\$1"
 ..
-.TH ovs\-vlan\-bug\-workaround 8 "February 2011" "Open vSwitch" "Open vSwitch Manual"
+.TH ovs\-vlan\-bug\-workaround 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .ds PN ovs\-vlan\-bug\-workaround
 .
 .SH NAME
diff --git a/utilities/ovs-vlan-test.8.in b/utilities/ovs-vlan-test.8.in
index 0f7c5648e..2cdeff832 100644
--- a/utilities/ovs-vlan-test.8.in
+++ b/utilities/ovs-vlan-test.8.in
@@ -3,7 +3,7 @@
 .  ns
 .  IP "\\$1"
 ..
-.TH ovs\-vlan\-test 1 "December 2010" "Open vSwitch" "Open vSwitch Manual"
+.TH ovs\-vlan\-test 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .
 .SH NAME
 \fBovs\-vlan\-test\fR \- check Linux drivers for problems with vlan traffic
diff --git a/utilities/ovs-vsctl.8.in b/utilities/ovs-vsctl.8.in
index e3ca78b35..e19340f37 100644
--- a/utilities/ovs-vsctl.8.in
+++ b/utilities/ovs-vsctl.8.in
@@ -10,7 +10,7 @@
 .  I "\\$1"
 .  RE
 ..
-.TH ovs\-vsctl 8 "November 2009" "Open vSwitch" "Open vSwitch Manual"
+.TH ovs\-vsctl 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .\" This program's name:
 .ds PN ovs\-vsctl
 .\" SSL peer program's name:
diff --git a/vswitchd/ovs-vswitchd.8.in b/vswitchd/ovs-vswitchd.8.in
index 9d66a61c7..764ed4147 100644
--- a/vswitchd/ovs-vswitchd.8.in
+++ b/vswitchd/ovs-vswitchd.8.in
@@ -4,7 +4,7 @@
 .  ns
 .  IP "\\$1"
 ..
-.TH ovs\-vswitchd 8 "June 2009" "Open vSwitch" "Open vSwitch Manual"
+.TH ovs\-vswitchd 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .\" This program's name:
 .ds PN ovs\-vswitchd
 .\" SSL peer program's name:
-- 
2.43.0