[PATCH] "escape" .hg/hgrc in command doc strings for asciidoc (#1072)
Alexis S. L. Carvalho
alexis at cecm.usp.br
Sun Apr 6 04:05:41 CDT 2008
Thus spake Matt Mackall:
> On Fri, 2008-04-04 at 08:42 +0200, Christian Ebert wrote:
> > The more one looks at it, the messier it gets ;)
> >
> > hgrc.5.txt already uses <repo>/.hg/hgrc
> >
> > Seems better to me, but more rewrapping needed.
> >
> > How about .hgignore? .hgtags?
> >
> > Rewrapping command doc strings to a smaller width is indicated as
> > well, as in hg.1 they are displayed with a huge indent.
> >
> > Do something about it? Or just wait until someone comes up with
> > man format without asciidoc?
>
> Going to man format is easy: take the existing output of asciidoc and
> tidy it up. Ok, we still need some gendoc hacking..
I'd prefer to keep using asciidoc.
I think we want to make the text of all manpages available through hg
help (in smaller pieces - e.g. one hgrc-<section> topic for each
section. A script would put the whole manpage back together). And then
asciidoc markup will be much less intrusive than troff.
To fix these escaping problems[1] it might be easier to just:
- remove the ".*.swp" example from hgignore.5.txt
- run the resulting manpages through sed -e 's/^\.hg/\\\&.hg/'
Alexis
[1] - which are caused by old docbook stylesheets and not asciidoc
itself (but the problem would obviously go away if we stopped
using asciidoc)
More information about the Mercurial-devel
mailing list