Mercurial > hg
annotate doc/README @ 5675:a5fe27b83a4a
Issue 882: add standard hook to reject text files with CRLF.
While the win32text extension does LF <-> CRLF conversion, and will issue a
warning in case a file already in the repository uses CRLF, it provides no
mechanism for verifying that incoming changes use LF. In a large development
team with some Windows users, it is virtually guaranteed that someone will
forget to set up the encode filter correctly and accidentally check in a file
using CRLF, which can cause warnings for other Windows users when they next
fetch changes. Since this is a general problem it is desirable to have a
pre-commit (or -push) hook available to reject such accidents earlier rather
than trying to fix them up after the fact.
author | Jesse Glick <jesse.glick@sun.com> |
---|---|
date | Wed, 19 Dec 2007 17:02:31 -0500 |
parents | 8db8e1100f3f |
children | bc1de09090bc |
rev | line source |
---|---|
453 | 1 Mercurial's documentation is currently kept in ASCIIDOC format, which |
2 is a simple plain text format that's easy to read and edit. It's also | |
3 convertible to a variety of other formats including standard UNIX man | |
4 page format and HTML. | |
177 | 5 |
453 | 6 To do this, you'll need to install ASCIIDOC: |
177 | 7 |
453 | 8 http://www.methods.co.nz/asciidoc/ |
177 | 9 |
453 | 10 To generate the man page: |
177 | 11 |
453 | 12 asciidoc -d manpage -b docbook hg.1.txt |
13 xmlto man hg.1.xml | |
177 | 14 |
453 | 15 To display: |
177 | 16 |
453 | 17 groff -mandoc -Tascii hg.1 | more |
177 | 18 |
453 | 19 To create the html page (without stylesheets): |
177 | 20 |
5048
8db8e1100f3f
Update asciidoc instructions to suggest html4 for newer versions
Brendan Cully <brendan@kublai.com>
parents:
453
diff
changeset
|
21 asciidoc -b html4 hg.1.txt |
8db8e1100f3f
Update asciidoc instructions to suggest html4 for newer versions
Brendan Cully <brendan@kublai.com>
parents:
453
diff
changeset
|
22 |
8db8e1100f3f
Update asciidoc instructions to suggest html4 for newer versions
Brendan Cully <brendan@kublai.com>
parents:
453
diff
changeset
|
23 (older asciidoc may want html instead of html4 above) |