summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2013-04-01 09:19:40 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2013-04-01 09:19:40 -0700
commit432930bd337c5432851b644bec083086759a3070 (patch)
treea3d56ce451159355e0841b3a1d6508e54ef18632 /Documentation
parentMerge branch 'yd/doc-merge-annotated-tag' into maint (diff)
parentCodingGuidelines: our documents are in AsciiDoc (diff)
downloadtgif-432930bd337c5432851b644bec083086759a3070.tar.xz
Merge branch 'yd/doc-is-in-asciidoc' into maint
* 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 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