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 Pierre-Yves David <pierre-yves.david@octobus.net>
Wed, 29 Sep 2021 01:23:10 +0200
changeset 48112 fabf687df0ff
parent 9419 3516a4e877c1
permissions -rw-r--r--
dirstate-item: update the attribute documentation It was very outdated. We are about to change these attribute so we should has well have them documented so that the change get easier to grasp.
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