[issue1072] hg(1), hgignore(5): incorrect groff code

[Gerardo Curiel]

New submission from Gerardo Curiel <gcuriel at gmail.com>:

The following is a existing bug in the mercurial manpages. I've attached a
partial patch, it encloses the problematic area of the hgignore manpage in a
LiteralBlock [0]. But the hg manpage is problematic, because it's generated in
build time. I'd like to find another solution than doing some awk/sed hack to
the gendoc.py output while building the debian package(that was my first ugly
approach).

Here's the debian bug report[1].


[0] http://www.methods.co.nz/asciidoc/userguide.html#_literal_blocks	
[1] http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=462131

---------------------------BEGIN MAIL----------------------------

Some manual pages seem to contain incorrect Groff code, like:

$ zcat usr/share/man/man1/hg.1.gz | nl -ba 
...
   431	.nf
   432	The location of the source is added to the new repository\'s
   433	\.hg/hgrc file, as the default to be used for future pulls\.
   434	.fi
   435	.RE
...
$ 

	Which gets rendered as:

--cut: hg(1)--
               basename of the source.

               The location of the source is added to the new repository's

               For efficiency, hardlinks are used for cloning whenever the source
--cut: hg(1)--

	Note the missing `.hg/hgrc file [...]' part.

	The following script seems to find a few more problem points
	like the above (using `man-db' from Bzr [1] and `groff'
	1.18.1.1-12):

$ (for f in usr/share/man/man?/* ; do \
       echo "* $f..." && man -t --warnings=w "$f" 2>&1 > /dev/null ; \
   done) 
* usr/share/man/man1/hg.1.gz...
<standard input>:433: warning: `hg/hgrc' not defined
<standard input>:2148: warning: `hgignore' not defined
<standard input>:2153: warning: `hgtags' not defined
* usr/share/man/man1/hgmerge.1.gz...
* usr/share/man/man5/hgignore.5.gz...
<standard input>:63: warning: `*.swp' not defined
* usr/share/man/man5/hgrc.5.gz...
$ 

	May it be actually an asciidoc(1) fault?

[1] http://www.chiark.greenend.org.uk/~cjwatson/bzr/man-db/trunk/

-----------------------END MAIL-------------------

----------
messages: 5809
nosy: gerardo
priority: bug
status: unread
title: hg(1), hgignore(5): incorrect groff code
topic: doc, patch

____________________________________________________
Mercurial issue tracker <mercurial-bugs at selenic.com>
<http://www.selenic.com/mercurial/bts/issue1072>
____________________________________________________