doc/README
author Alexis S. L. Carvalho <alexis@cecm.usp.br>
Thu, 04 Oct 2007 23:21:37 -0300
changeset 5378 8a2915f57dfc
parent 5048 8db8e1100f3f
permissions -rw-r--r--
convert: add a mode where mercurial_sink skips empty revisions. The getchanges function of some converter_source classes can return some false positives. I.e. they sometimes claim that a file "foo" was changed in some revision, even though its contents are still the same. convert_svn is particularly bad, but I think this can also happen with convert_cvs and, at least in theory, with mercurial_source. For regular conversions this is not really a problem - as long as getfile returns the right contents, we'll get a converted revision with the right contents. But when we use --filemap, this could lead to superfluous revisions being converted. Instead of fixing every converter_source, I decided to change mercurial_sink to work around this problem. When --filemap is used, we're interested only in revisions that touch some specific files. If a revision doesn't change any of these files, then we're not interested in it (at least for revisions with a single parent; merges are special). For mercurial_sink, we abuse this property and rollback a commit if the manifest text hasn't changed. This avoids duplicating the logic from localrepo.filecommit to detect unchanged files.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
5048
8db8e1100f3f Update asciidoc instructions to suggest html4 for newer versions
Brendan Cully <brendan@kublai.com>
parents: 453
diff changeset
    21
 asciidoc -b html4 hg.1.txt
8db8e1100f3f Update asciidoc instructions to suggest html4 for newer versions
Brendan Cully <brendan@kublai.com>
parents: 453
diff changeset
    22
8db8e1100f3f Update asciidoc instructions to suggest html4 for newer versions
Brendan Cully <brendan@kublai.com>
parents: 453
diff changeset
    23
(older asciidoc may want html instead of html4 above)