doc/README
author Alexis S. L. Carvalho <alexis@cecm.usp.br>
Fri, 08 Jun 2007 23:49:12 -0300
changeset 4525 78b6add1f966
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
Add dirstate.pathto and localrepo.pathto. Every time util.pathto is called, we have to pass the repo root and the repo cwd. dirstate.pathto is a simple convenience function that knows about the root and the cwd arguments. It's still possible to pass the cwd as an optimization. localrepo.pathto is a convenience function that just calls dirstate.pathto, just like localrepo.getcwd. dirstate.pathto becomes a single point that converts most (all?) paths from the internal representation to some OS-specific relative path for display purposes.

Mercurial's documentation is currently kept in ASCIIDOC format, which
is a simple plain text format that's easy to read and edit. It's also
convertible to a variety of other formats including standard UNIX man
page format and HTML.

To do this, you'll need to install ASCIIDOC:

 http://www.methods.co.nz/asciidoc/

To generate the man page:

 asciidoc -d manpage -b docbook hg.1.txt
 xmlto man hg.1.xml

To display:

 groff -mandoc -Tascii hg.1 | more

To create the html page (without stylesheets):

 asciidoc -b html hg.1.txt