2
0
mirror of https://github.com/openvswitch/ovs synced 2025-08-31 22:35:15 +00:00

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>
This commit is contained in:
Ben Pfaff
2013-01-02 10:19:14 -08:00
parent 0d8e96383b
commit d2cb6c956b
20 changed files with 24 additions and 22 deletions

View File

@@ -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:

View File

@@ -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 = []

View File

@@ -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:

View File

@@ -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

View File

@@ -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 \

View File

@@ -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
.

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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)
.BR uname (1)

View File

@@ -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

View File

@@ -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

View File

@@ -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:

View File

@@ -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: