summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2013-03-28 14:38:20 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2013-03-28 14:38:20 -0700
commitf893be27123ab95590ad568730d22b126cf4bd97 (patch)
treee1312af90c55cca811241f907464c08eab2c3cd3
parentMerge branch 'yd/doc-merge-annotated-tag' (diff)
parentCodingGuidelines: our documents are in AsciiDoc (diff)
downloadtgif-f893be27123ab95590ad568730d22b126cf4bd97.tar.xz
Merge branch 'yd/doc-is-in-asciidoc'
* yd/doc-is-in-asciidoc: CodingGuidelines: our documents are in AsciiDoc
-rw-r--r--Documentation/CodingGuidelines3
1 files changed, 3 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index b1bfff630f..7e4d5716a6 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