doc/README
author Vadim Gelfer <vadim.gelfer@gmail.com>
Thu, 13 Apr 2006 17:11:04 -0700
changeset 2068 4a49daa3a40c
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
let run-tests run optional code coverage tests. to enable, set env var TEST_COVERAGE to non-empty string. run-tests will print report after running. after coverage run, file tests/.coverage will contain coverage data. use tests/coverage.py to get more info, like annotated source code.

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