summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2013-03-28 21:38:20 (GMT)
committerJunio C Hamano <gitster@pobox.com>2013-03-28 21:38:20 (GMT)
commitf893be27123ab95590ad568730d22b126cf4bd97 (patch)
treee1312af90c55cca811241f907464c08eab2c3cd3 /Documentation
parentf1c8d8338f54c5aec18f4d0efa37cec30aafe12a (diff)
parentbb9f2aecf0e212702cdb66e58b16e8e470e596cf (diff)
downloadgit-f893be27123ab95590ad568730d22b126cf4bd97.zip
git-f893be27123ab95590ad568730d22b126cf4bd97.tar.gz
git-f893be27123ab95590ad568730d22b126cf4bd97.tar.bz2
Merge branch 'yd/doc-is-in-asciidoc'
* yd/doc-is-in-asciidoc: CodingGuidelines: our documents are in AsciiDoc
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/CodingGuidelines3
1 files changed, 3 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index b1bfff6..7e4d571 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -237,6 +237,9 @@ For Python scripts:
Writing Documentation:
+ Most (if not all) of the documentation pages are written in AsciiDoc
+ and processed into HTML output and manpages.
+
Every user-visible change should be reflected in the documentation.
The same general rule as for code applies -- imitate the existing
conventions. A few commented examples follow to provide reference