doc/README
author mpm@selenic.com
Sat, 04 Jun 2005 14:16:32 -0800
changeset 249 619e775aa7f9
parent 182 089594a5bbde
child 453 7a3a3952c431
permissions -rw-r--r--
import and startup cleanups -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 import and startup cleanups add commands:run() add copyright notice to commands eliminate/reorganize imports to speed up start time: 0.5b: $ time bash -c 'for i in `seq 100`; do ~/bin/hg > /dev/null; done' real 0m7.718s user 0m6.719s sys 0m0.794s new: $ time bash -c 'for i in `seq 100`; do hg > /dev/null; done' real 0m2.171s user 0m1.684s sys 0m0.444s just python: $ time bash -c 'for i in `seq 100`; do python -c pass; done' real 0m0.988s user 0m0.771s sys 0m0.207s Ignoring the fixed cost of loading the Python interpreter, we're 5.6 times faster. With the Python load time, we're still 3.5 times faster. manifest hash: acce5882a55c76eb165316f5741724c8ce4ef587 -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCoihAywK+sNU5EO8RAqMdAJwMe6Ur0R9G6jjayNa5hH2C3c4k/gCeIYvc N178vaWWGciX9zq+g5qCAls= =buhv -----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