annotate doc/README @ 4369:d7ad1e42a368

util._matcher: speed up regexp matching. In 4babaa52badf, Benoit made a change that substantially slows matching when a big .hgignore file is in play, because it calls into the regexp matching engine potentially hundreds of times per file to be matched. I've partly rolled back his change, so that we only call into the matcher once per file, but preserved the ability to report a meaningful error message if there's a syntax error in the regexp.
author Bryan O'Sullivan <bos@serpentine.com>
date Tue, 24 Apr 2007 10:53:25 -0700
parents 7a3a3952c431
children 8db8e1100f3f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
1 Mercurial's documentation is currently kept in ASCIIDOC format, which
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
2 is a simple plain text format that's easy to read and edit. It's also
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
3 convertible to a variety of other formats including standard UNIX man
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
4 page format and HTML.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
5
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
6 To do this, you'll need to install ASCIIDOC:
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
7
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
8 http://www.methods.co.nz/asciidoc/
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
9
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
10 To generate the man page:
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
11
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
12 asciidoc -d manpage -b docbook hg.1.txt
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
13 xmlto man hg.1.xml
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
14
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
15 To display:
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
16
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
17 groff -mandoc -Tascii hg.1 | more
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
18
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
19 To create the html page (without stylesheets):
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
20
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
21 asciidoc -b html hg.1.txt