Skip to content

Commit 23edef9

Browse files
committed
Fix manpage-check on RHEL 5.
The version of groff on RHEL 5 doesn't include the .SY, .OP, or .YS macros that ovs-benchmark.1 uses, so the manpage-check target fails on that platform. This commit adds the groff definitions of those macros to a file and includes it into ovs-benchmark.1. I tested that this allows RHEL 5 to pass manpage-check.
1 parent dfbf7f3 commit 23edef9

6 files changed

Lines changed: 213 additions & 7 deletions

File tree

NOTICE

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ This file is included in compliance with the Apache 2.0 license,
22
available at http://www.apache.org/licenses/LICENSE-2.0.html
33

44
Open vSwitch
5-
Copyright (c) 2007, 2008, 2009 Nicira Networks.
5+
Copyright (c) 2007, 2008, 2009, 2010, 2011 Nicira Networks.
66

77
Apache Portable Runtime
88
Copyright 2008 The Apache Software Foundation.
@@ -13,3 +13,6 @@ The Apache Software Foundation (http://www.apache.org/).
1313
Portions of this software were developed at the National Center
1414
for Supercomputing Applications (NCSA) at the University of
1515
Illinois at Urbana-Champaign.
16+
17+
lib/ovs.tmac includes troff macros written by Eric S. Raymond
18+
and Werner Lemberg.

debian/copyright.in

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,20 @@ License:
141141
agrees to be bound by the terms and conditions of this License
142142
Agreement.
143143

144+
* lib/ovs.tmac in the source distribution, and manpages in the
145+
binaries, includes troff macros from groff 1.21 that contain the
146+
following notice:
147+
148+
.\" an-ext.tmac
149+
.\"
150+
.\" Written by Eric S. Raymond <esr@thyrsus.com>
151+
.\" Werner Lemberg <wl@gnu.org>
152+
.\"
153+
.\" Version 2007-Feb-02
154+
.\"
155+
.\" Copyright (C) 2007, 2009, 2011 Free Software Foundation, Inc.
156+
.\" You may freely use, modify and/or distribute this file.
157+
144158
* All other components of this package are licensed under
145159
The Apache License Version 2.0.
146160

lib/automake.mk

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,7 @@ MAN_FRAGMENTS += \
249249
lib/daemon.man \
250250
lib/daemon-syn.man \
251251
lib/leak-checker.man \
252+
lib/ovs.tmac \
252253
lib/ssl-bootstrap.man \
253254
lib/ssl-bootstrap-syn.man \
254255
lib/ssl-peer-ca-cert.man \

lib/ovs.tmac

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
.\" -*- nroff -*-
2+
.\" ovs.tmac
3+
.\"
4+
.\" Open vSwitch troff macro library
5+
.
6+
.
7+
.\" Continuation line for .IP.
8+
.de IQ
9+
. br
10+
. ns
11+
. IP "\\$1"
12+
..
13+
.
14+
.\" Introduces a sub-subsection
15+
.de ST
16+
. PP
17+
. RS -0.15in
18+
. I "\\$1"
19+
. RE
20+
..
21+
.
22+
.\" The content between the lines below is from an-ext.tmac in groff
23+
.\" 1.21, with some modifications.
24+
.\" ----------------------------------------------------------------------
25+
.\" an-ext.tmac
26+
.\"
27+
.\" Written by Eric S. Raymond <esr@thyrsus.com>
28+
.\" Werner Lemberg <wl@gnu.org>
29+
.\"
30+
.\" Version 2007-Feb-02
31+
.\"
32+
.\" Copyright (C) 2007, 2009, 2011 Free Software Foundation, Inc.
33+
.\" You may freely use, modify and/or distribute this file.
34+
.\"
35+
.\"
36+
.\" The code below provides extension macros for the `man' macro package.
37+
.\" Care has been taken to make the code portable; groff extensions are
38+
.\" properly hidden so that all troff implementations can use it without
39+
.\" changes.
40+
.\"
41+
.\" With groff, this file is sourced by the `man' macro package itself.
42+
.\" Man page authors who are concerned about portability might add the
43+
.\" used macros directly to the prologue of the man page(s).
44+
.
45+
.
46+
.\" Convention: Auxiliary macros and registers start with `m' followed
47+
.\" by an uppercase letter or digit.
48+
.
49+
.
50+
.\" Declare start of command synopsis. Sets up hanging indentation.
51+
.de SY
52+
. ie !\\n(mS \{\
53+
. nh
54+
. nr mS 1
55+
. nr mA \\n(.j
56+
. ad l
57+
. nr mI \\n(.i
58+
. \}
59+
. el \{\
60+
. br
61+
. ns
62+
. \}
63+
.
64+
. HP \w'\fB\\$1\fP\ 'u
65+
. B "\\$1"
66+
..
67+
.
68+
.
69+
.\" End of command synopsis. Restores adjustment.
70+
.de YS
71+
. in \\n(mIu
72+
. ad \\n(mA
73+
. hy \\n(HY
74+
. nr mS 0
75+
..
76+
.
77+
.
78+
.\" Declare optional option.
79+
.de OP
80+
. ie \\n(.$-1 \
81+
. RI "[\fB\\$1\fP" "\ \\$2" "]"
82+
. el \
83+
. RB "[" "\\$1" "]"
84+
..
85+
.
86+
.
87+
.\" Start URL.
88+
.de UR
89+
. ds m1 \\$1\"
90+
. nh
91+
. if \\n(mH \{\
92+
. \" Start diversion in a new environment.
93+
. do ev URL-div
94+
. do di URL-div
95+
. \}
96+
..
97+
.
98+
.
99+
.\" End URL.
100+
.de UE
101+
. ie \\n(mH \{\
102+
. br
103+
. di
104+
. ev
105+
.
106+
. \" Has there been one or more input lines for the link text?
107+
. ie \\n(dn \{\
108+
. do HTML-NS "<a href=""\\*(m1"">"
109+
. \" Yes, strip off final newline of diversion and emit it.
110+
. do chop URL-div
111+
. do URL-div
112+
\c
113+
. do HTML-NS </a>
114+
. \}
115+
. el \
116+
. do HTML-NS "<a href=""\\*(m1"">\\*(m1</a>"
117+
\&\\$*\"
118+
. \}
119+
. el \
120+
\\*(la\\*(m1\\*(ra\\$*\"
121+
.
122+
. hy \\n(HY
123+
..
124+
.
125+
.
126+
.\" Start email address.
127+
.de MT
128+
. ds m1 \\$1\"
129+
. nh
130+
. if \\n(mH \{\
131+
. \" Start diversion in a new environment.
132+
. do ev URL-div
133+
. do di URL-div
134+
. \}
135+
..
136+
.
137+
.
138+
.\" End email address.
139+
.de ME
140+
. ie \\n(mH \{\
141+
. br
142+
. di
143+
. ev
144+
.
145+
. \" Has there been one or more input lines for the link text?
146+
. ie \\n(dn \{\
147+
. do HTML-NS "<a href=""mailto:\\*(m1"">"
148+
. \" Yes, strip off final newline of diversion and emit it.
149+
. do chop URL-div
150+
. do URL-div
151+
\c
152+
. do HTML-NS </a>
153+
. \}
154+
. el \
155+
. do HTML-NS "<a href=""mailto:\\*(m1"">\\*(m1</a>"
156+
\&\\$*\"
157+
. \}
158+
. el \
159+
\\*(la\\*(m1\\*(ra\\$*\"
160+
.
161+
. hy \\n(HY
162+
..
163+
.
164+
.
165+
.\" Continuation line for .TP header.
166+
.de TQ
167+
. br
168+
. ns
169+
. TP \\$1\" no doublequotes around argument!
170+
..
171+
.
172+
.
173+
.\" Start example.
174+
.de EX
175+
. nr mE \\n(.f
176+
. nf
177+
. nh
178+
. ft CW
179+
..
180+
.
181+
.
182+
.\" End example.
183+
.de EE
184+
. ft \\n(mE
185+
. fi
186+
. hy \\n(HY
187+
..
188+
.
189+
.\" EOF
190+
.\" ----------------------------------------------------------------------

manpages.mk

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,10 @@ utilities/ovs-appctl.8.in:
8585
lib/common.man:
8686

8787
utilities/ovs-benchmark.1: \
88-
utilities/ovs-benchmark.1.in
88+
utilities/ovs-benchmark.1.in \
89+
lib/ovs.tmac
8990
utilities/ovs-benchmark.1.in:
91+
lib/ovs.tmac:
9092

9193
utilities/ovs-controller.8: \
9294
utilities/ovs-controller.8.in \

utilities/ovs-benchmark.1.in

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
.\" -*- nroff -*-
2-
.de IQ
3-
. br
4-
. ns
5-
. IP "\\$1"
6-
..
2+
.so lib/ovs.tmac
73
.TH ovs\-benchmark 1 "July 2011" "Open vSwitch" "Open vSwitch Manual"
84
.
95
.SH NAME

0 commit comments

Comments
 (0)