On Tue, Apr 18, 2017 at 11:58:27AM +0100, Stephen Finucane wrote: > On Thu, 2017-04-13 at 21:43 -0700, Ben Pfaff wrote: > > From: Stephen Finucane <[email protected]> > > > > Let's start with a simple one that lets us focus on setting up most > > of > > the required "infrastructure" for building man pages using Sphinx. > > > > This changes the 'check-htmldocs' target to 'check-docs' as its now > > responsible for building man page docs too. > > > > Other than that, hurrah for (mostly) legible syntaxes. > > > > [1] http://www.tldp.org/HOWTO/Man-Page/q2.html > > This mostly looks good to me. Some comments below but nothing I'd block > on. > > Acked-by: Stephen Finucane <[email protected]>
Thanks! > > + > > I might have done something funky applying this, but I can see a '^L' > character (linefeed?) on this line. Might be worth watching for. ^L is a form-feed. We often use it to divide files into logical sections, mostly in C files but there are some other examples in the repo in tests/automake.mk, in some .at files, and in some Python files. (I originally picked up this habit decades ago from reading the GNU coding standards.) > > +UNINSTALL_LOCAL += uninstall-man-rst > > +uninstall-man-rst: > > + @$(set_mandirs); \ > > + for rst in $(RST_MANPAGES); do \ > > + $(extract_stem_and_section); \ > > + echo "rm -f '$(DESTDIR)'\"$$mandir/$$stem.$$section\""; > > \ > > + rm -f '$(DESTDIR)'"$$mandir/$$stem.$$section"; \ > > + done > > This whole section is still mostly noise to me and I would love to > simplify it somehow. I'm not ready to do that yet though and so long as > I don't have to maintain this (:)), I can live with it as-is. Might be > good to get someone else with more autotools know-how to look at it > though? Possibly that's a good idea but it's hard to get anyone to look at this kind of thing. I'm willing to maintain it. > > --- /dev/null > > +++ b/Documentation/ref/ovs-vlan-test.8.rst > > @@ -0,0 +1,115 @@ > > +============= > > +ovs-vlan-test > > +============= > > + > > +Synopsis > > +======== > > + > > +**ovs-vlan-test** [**-s** | **--server**] *control_ip* *vlan_ip* > > This results in better man page output at the expense of the HTML > output (which is no longer monospaced as you'd expect). The 'code- > block' directive would probably help here, but that causes issues for > some users. Guess we'll just live with it for now. Oh, that's an interesting point. The reason I moved it to the left margin was that it looked like it was indented wrong in the output anyway. Let's keep this in mind for the future. _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
