doc/README
author mpm@selenic.com
Wed, 15 Jun 2005 21:11:40 -0800
changeset 373 67081329d49a
parent 182 089594a5bbde
child 453 7a3a3952c431
permissions -rw-r--r--
Change the size of the short hash representation -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Change the size of the short hash representation First note that this number doesn't really matter, as we always check for ambiguous short hash ids. Here's the math on collision probability: >>> import math >>> def p(f, n): return 1 - (1 / math.exp(n**2/(2*f))) ... >>> p(2**32, 30000.0) 0.09947179164613551 # with 30000 changesets (BKCVS), we have a 9% chance >>> p(2**32, 65000.0) 0.38850881217977273 # and with a full import from BK, we'd have a 39% chance >>> p(2**40, 1e6) 0.36539171908447321 # we'd like to be "safe" for 1M csets, so 40 isn't enough >>> p(2**48, 1e6) 0.001774780051374103 # But 48 looks good >>> p(2**48, 1e7) 0.16275260939624481 >>> p(2**48, 5e6) 0.043437281083569146 >>> p(2**48, 2e6) 0.0070802434913129764 >>> p(2**48, 3e6) 0.01586009440574343 manifest hash: 24d9f928a463f46708b0e11fb781d5a241851424 -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCsQoMywK+sNU5EO8RAoBBAJwII9GV6dT9QUOYAk3gZGw9z0JvjACfSI4q IFnTu1F7P5OuLelO1GsM8Bs= =CNWk -----END PGP SIGNATURE-----
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     1
Files in this directory:
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     2
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     3
README - this file
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     4
hg.1.txt - asciidoc source for the files
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     5
hg.1 - groff man page for hg
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     6
hg.1.html - man page in html format
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     7
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     8
How to generate the man page and html files
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     9
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    10
For now we use asciidoc which is available at:
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    11
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    12
http://www.methods.co.nz/asciidoc/
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    13
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    14
the file hg.1.txt is the input file, to generate the man page:
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    15
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    16
asciidoc.py -d manpage -b docbook hg.1.txt
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    17
xmlto man hg.1.xml
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    18
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    19
to display:
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    20
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    21
groff -mandoc -Tascii hg.1 | more
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    22
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    23
to create the html page (without stylesheets):
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    24
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    25
asciidoc.py -b html hg.1.txt