doc/README
author Pierre-Yves David <pierre-yves.david@fb.com>
Fri, 17 Oct 2014 22:19:05 -0700
changeset 23358 1b51d1b05482
parent 9419 3516a4e877c1
permissions -rw-r--r--
transaction: write pending generated files Such file are generated with a .pending prefix. It is up to the reader to implement the necessary logic for reading pending files. We add a test to ensure pending files are properly cleaned-up in both success and error cases.

Mercurial's documentation is kept in reStructuredText format, which is
a simple plain text format that's easy to read and edit:

  http://docutils.sourceforge.net/rst.html

It's also convertible to a variety of other formats including standard
UNIX man page format and HTML. You'll need to install Docutils:

  http://docutils.sourceforge.net/

Use the Makefile in this directory to generate the man and HTML pages.