doc/README
author Alexis S. L. Carvalho <alexis@cecm.usp.br>
Sat, 09 Jun 2007 01:04:28 -0300
changeset 4531 b51a8138292a
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
Avoid extra filelogs entries. Right now, there are some situations in which localrepo.filecommit can create filelog entries even though they're not needed. For example: - permissions for a file have changed; - qrefresh can create a filelog entry identical to its parent (see the added test); - convert-repo creates extra filelog entries in every merge where the first parent has added files (for example, changeset ebebe9577a1a of the kernel repo added extra filelog entries to files in the arch/blackfin directory, even though the merge should only touch the drivers/ata directory). This makes "hg log file" in a converted repo less useful than it could be, since it may mention many merges that don't actually touch that specific file. They all come from the same basic problem: localrepo.commit (through filecommit) creates new filelog entries for all files passed to it (except for some cases during a merge). Patch and test case provided by Benoit. This should fix issue351.
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
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
    21
 asciidoc -b html hg.1.txt