Looks good. Ethan
On Thu, Oct 27, 2011 at 09:39, Ben Pfaff <b...@nicira.com> wrote: > 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. > --- > NOTICE | 5 +- > debian/copyright.in | 14 +++ > lib/automake.mk | 1 + > lib/ovs.tmac | 190 > ++++++++++++++++++++++++++++++++++++++++++ > manpages.mk | 4 +- > utilities/ovs-benchmark.1.in | 6 +- > 6 files changed, 213 insertions(+), 7 deletions(-) > create mode 100644 lib/ovs.tmac > > diff --git a/NOTICE b/NOTICE > index 27587b5..d2aa9aa 100644 > --- a/NOTICE > +++ b/NOTICE > @@ -2,7 +2,7 @@ This file is included in compliance with the Apache 2.0 > license, > available at http://www.apache.org/licenses/LICENSE-2.0.html > > Open vSwitch > -Copyright (c) 2007, 2008, 2009 Nicira Networks. > +Copyright (c) 2007, 2008, 2009, 2010, 2011 Nicira Networks. > > Apache Portable Runtime > Copyright 2008 The Apache Software Foundation. > @@ -13,3 +13,6 @@ The Apache Software Foundation (http://www.apache.org/). > Portions of this software were developed at the National Center > for Supercomputing Applications (NCSA) at the University of > Illinois at Urbana-Champaign. > + > +lib/ovs.tmac includes troff macros written by Eric S. Raymond > +and Werner Lemberg. > diff --git a/debian/copyright.in b/debian/copyright.in > index 3792dd1..5a0bcfc 100644 > --- a/debian/copyright.in > +++ b/debian/copyright.in > @@ -141,6 +141,20 @@ License: > agrees to be bound by the terms and conditions of this License > Agreement. > > +* lib/ovs.tmac in the source distribution, and manpages in the > + binaries, includes troff macros from groff 1.21 that contain the > + following notice: > + > + .\" an-ext.tmac > + .\" > + .\" Written by Eric S. Raymond <e...@thyrsus.com> > + .\" Werner Lemberg <w...@gnu.org> > + .\" > + .\" Version 2007-Feb-02 > + .\" > + .\" Copyright (C) 2007, 2009, 2011 Free Software Foundation, Inc. > + .\" You may freely use, modify and/or distribute this file. > + > * All other components of this package are licensed under > The Apache License Version 2.0. > > diff --git a/lib/automake.mk b/lib/automake.mk > index 1320e31..6484518 100644 > --- a/lib/automake.mk > +++ b/lib/automake.mk > @@ -249,6 +249,7 @@ MAN_FRAGMENTS += \ > lib/daemon.man \ > lib/daemon-syn.man \ > lib/leak-checker.man \ > + lib/ovs.tmac \ > lib/ssl-bootstrap.man \ > lib/ssl-bootstrap-syn.man \ > lib/ssl-peer-ca-cert.man \ > diff --git a/lib/ovs.tmac b/lib/ovs.tmac > new file mode 100644 > index 0000000..5f8f20a > --- /dev/null > +++ b/lib/ovs.tmac > @@ -0,0 +1,190 @@ > +.\" -*- nroff -*- > +.\" ovs.tmac > +.\" > +.\" Open vSwitch troff macro library > +. > +. > +.\" Continuation line for .IP. > +.de IQ > +. br > +. ns > +. IP "\\$1" > +.. > +. > +.\" Introduces a sub-subsection > +.de ST > +. PP > +. RS -0.15in > +. I "\\$1" > +. RE > +.. > +. > +.\" The content between the lines below is from an-ext.tmac in groff > +.\" 1.21, with some modifications. > +.\" ---------------------------------------------------------------------- > +.\" an-ext.tmac > +.\" > +.\" Written by Eric S. Raymond <e...@thyrsus.com> > +.\" Werner Lemberg <w...@gnu.org> > +.\" > +.\" Version 2007-Feb-02 > +.\" > +.\" Copyright (C) 2007, 2009, 2011 Free Software Foundation, Inc. > +.\" You may freely use, modify and/or distribute this file. > +.\" > +.\" > +.\" The code below provides extension macros for the `man' macro package. > +.\" Care has been taken to make the code portable; groff extensions are > +.\" properly hidden so that all troff implementations can use it without > +.\" changes. > +.\" > +.\" With groff, this file is sourced by the `man' macro package itself. > +.\" Man page authors who are concerned about portability might add the > +.\" used macros directly to the prologue of the man page(s). > +. > +. > +.\" Convention: Auxiliary macros and registers start with `m' followed > +.\" by an uppercase letter or digit. > +. > +. > +.\" Declare start of command synopsis. Sets up hanging indentation. > +.de SY > +. ie !\\n(mS \{\ > +. nh > +. nr mS 1 > +. nr mA \\n(.j > +. ad l > +. nr mI \\n(.i > +. \} > +. el \{\ > +. br > +. ns > +. \} > +. > +. HP \w'\fB\\$1\fP\ 'u > +. B "\\$1" > +.. > +. > +. > +.\" End of command synopsis. Restores adjustment. > +.de YS > +. in \\n(mIu > +. ad \\n(mA > +. hy \\n(HY > +. nr mS 0 > +.. > +. > +. > +.\" Declare optional option. > +.de OP > +. ie \\n(.$-1 \ > +. RI "[\fB\\$1\fP" "\ \\$2" "]" > +. el \ > +. RB "[" "\\$1" "]" > +.. > +. > +. > +.\" Start URL. > +.de UR > +. ds m1 \\$1\" > +. nh > +. if \\n(mH \{\ > +. \" Start diversion in a new environment. > +. do ev URL-div > +. do di URL-div > +. \} > +.. > +. > +. > +.\" End URL. > +.de UE > +. ie \\n(mH \{\ > +. br > +. di > +. ev > +. > +. \" Has there been one or more input lines for the link text? > +. ie \\n(dn \{\ > +. do HTML-NS "<a href=""\\*(m1"">" > +. \" Yes, strip off final newline of diversion and emit it. > +. do chop URL-div > +. do URL-div > +\c > +. do HTML-NS </a> > +. \} > +. el \ > +. do HTML-NS "<a href=""\\*(m1"">\\*(m1</a>" > +\&\\$*\" > +. \} > +. el \ > +\\*(la\\*(m1\\*(ra\\$*\" > +. > +. hy \\n(HY > +.. > +. > +. > +.\" Start email address. > +.de MT > +. ds m1 \\$1\" > +. nh > +. if \\n(mH \{\ > +. \" Start diversion in a new environment. > +. do ev URL-div > +. do di URL-div > +. \} > +.. > +. > +. > +.\" End email address. > +.de ME > +. ie \\n(mH \{\ > +. br > +. di > +. ev > +. > +. \" Has there been one or more input lines for the link text? > +. ie \\n(dn \{\ > +. do HTML-NS "<a href=""mailto:\\*(m1"">" > +. \" Yes, strip off final newline of diversion and emit it. > +. do chop URL-div > +. do URL-div > +\c > +. do HTML-NS </a> > +. \} > +. el \ > +. do HTML-NS "<a href=""mailto:\\*(m1"">\\*(m1</a>" > +\&\\$*\" > +. \} > +. el \ > +\\*(la\\*(m1\\*(ra\\$*\" > +. > +. hy \\n(HY > +.. > +. > +. > +.\" Continuation line for .TP header. > +.de TQ > +. br > +. ns > +. TP \\$1\" no doublequotes around argument! > +.. > +. > +. > +.\" Start example. > +.de EX > +. nr mE \\n(.f > +. nf > +. nh > +. ft CW > +.. > +. > +. > +.\" End example. > +.de EE > +. ft \\n(mE > +. fi > +. hy \\n(HY > +.. > +. > +.\" EOF > +.\" ---------------------------------------------------------------------- > diff --git a/manpages.mk b/manpages.mk > index 8135a2c..c722d5d 100644 > --- a/manpages.mk > +++ b/manpages.mk > @@ -85,8 +85,10 @@ utilities/ovs-appctl.8.in: > lib/common.man: > > utilities/ovs-benchmark.1: \ > - utilities/ovs-benchmark.1.in > + utilities/ovs-benchmark.1.in \ > + lib/ovs.tmac > utilities/ovs-benchmark.1.in: > +lib/ovs.tmac: > > utilities/ovs-controller.8: \ > utilities/ovs-controller.8.in \ > diff --git a/utilities/ovs-benchmark.1.in b/utilities/ovs-benchmark.1.in > index f0ec370..1183fe8 100644 > --- a/utilities/ovs-benchmark.1.in > +++ b/utilities/ovs-benchmark.1.in > @@ -1,9 +1,5 @@ > .\" -*- nroff -*- > -.de IQ > -. br > -. ns > -. IP "\\$1" > -.. > +.so lib/ovs.tmac > .TH ovs\-benchmark 1 "July 2011" "Open vSwitch" "Open vSwitch Manual" > . > .SH NAME > -- > 1.7.4.4 > > _______________________________________________ > dev mailing list > dev@openvswitch.org > http://openvswitch.org/mailman/listinfo/dev > _______________________________________________ dev mailing list dev@openvswitch.org http://openvswitch.org/mailman/listinfo/dev
