doc/README
author Nicolas Dumazet <nicdumz.commits@gmail.com>
Mon, 05 Jul 2010 18:43:46 +0900
branchstable
changeset 11540 2370e270a29a
parent 9419 3516a4e877c1
permissions -rw-r--r--
filelog: test behaviour for data starting with "\1\n" Because "\1\n" is a separator for metadata, data starting with "\1\n" is handled specifically. It was not tested. size() call return incorrect data if original data had been "\1\n-escaped". There's no obvious way to fix it for now, just flag the error in the code and add an "expected failure" kind of test.

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.