]> granicus.if.org Git - git/commitdiff
CodingGuidelines: our documents are in AsciiDoc
authorJunio C Hamano <gitster@pobox.com>
Thu, 21 Mar 2013 21:17:32 +0000 (14:17 -0700)
committerJunio C Hamano <gitster@pobox.com>
Thu, 21 Mar 2013 21:17:32 +0000 (14:17 -0700)
Before talking about notations such as optional [--option] enclosed
in brackets, state that the documents are in AsciiDoc and processed
into other formats.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/CodingGuidelines

index b1bfff630fc0ec22d68757ebab84e76ee5abbc2c..7e4d5716a62bf59e8f072163ebac3064dad323ae 100644 (file)
@@ -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