Mercurial Mercurial > hg / annotate
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc/README
author Gregory Szorc <gregory.szorc@gmail.com>
Sun, 04 Feb 2018 14:44:04 -0800
changeset 35939 a622a927fe03
parent 9419 3516a4e877c1
permissions -rw-r--r--
sshpeer: document the handshake mechanism The mechanism by which SSH peers establish connections with remotes is wonky and requires a bit of code archeology to understand. While it is already documented in `hg help internals.wireproto`, it helps to have documentation in the code as well. Differential Revision: https://phab.mercurial-scm.org/D2035
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
9172
bc1de09090bc doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents: 5048
diff changeset 
     1
 
Mercurial's documentation is kept in reStructuredText format, which is
bc1de09090bc doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents: 5048
diff changeset 
     2
 
a simple plain text format that's easy to read and edit:
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset 
     3
 







9172






bc1de09090bc
doc: update README with links to Docutils



Martin Geisler <mg@lazybytes.net>


parents: 
5048

diff
changeset




     4


  http://docutils.sourceforge.net/rst.html








177






91055f795d88
adding doc directory and files



jake@edge2.net


parents: 

diff
changeset




     5









9172






bc1de09090bc
doc: update README with links to Docutils



Martin Geisler <mg@lazybytes.net>


parents: 
5048

diff
changeset




     6


It's also convertible to a variety of other formats including standard








9419






3516a4e877c1
doc/README: simplify instructions



Martin Geisler <mg@lazybytes.net>


parents: 
9406

diff
changeset




     7


UNIX man page format and HTML. You'll need to install Docutils:








177






91055f795d88
adding doc directory and files



jake@edge2.net


parents: 

diff
changeset




     8









9172






bc1de09090bc
doc: update README with links to Docutils



Martin Geisler <mg@lazybytes.net>


parents: 
5048

diff
changeset




     9


  http://docutils.sourceforge.net/








177






91055f795d88
adding doc directory and files



jake@edge2.net


parents: 

diff
changeset




    10









9172






bc1de09090bc
doc: update README with links to Docutils



Martin Geisler <mg@lazybytes.net>


parents: 
5048

diff
changeset




    11


Use the Makefile in this directory to generate the man and HTML pages.















Mercurial