Mercurial > hg > mercurial-crew-with-dirclash
view doc/README @ 2901:05f357b70cb0
Tune a bit the extdiff toplevel comments/samples.
* Capitalize the first letter of all sentences
* Add an example for GNU diff(1) 'context diff' mode.
* Explain the requirement for separate cmd.xxx and opts.xxx
options in .hgrc, which hopefully will guard against users
trying to add:
[extdiff]
# Add a new Mercurial command called `cdiff', which calls
# GNU diff(1) in 'context diff' mode.
cmd.cdiff = diff -Nprc5
which fails for recent crew builds with:
$ hg cdiff .
making snapshot of 1 files from rev 07dc4a569f4e
making snapshot of 1 files from working dir
diff -Nprc5: not found
The correct way to do this is by separating the cmd.cdiff and
opts.cdiff parts like this:
[extdiff]
# Add a new Mercurial command called `cdiff', which calls
# GNU diff(1) in 'context diff' mode.
cmd.cdiff = diff
opts.cdiff = -Nprc5
so add it as a new example and explicitly describe it in the
extdiff comments.
author | Giorgos Keramidas <keramida@ceid.upatras.gr> |
---|---|
date | Tue, 15 Aug 2006 18:14:58 +0300 |
parents | 7a3a3952c431 |
children | 8db8e1100f3f |
line wrap: on
line source
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