CodingGuidelines: our documents are in AsciiDoc
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>
Junio C Hamano committed
Mar 21, 2013 at 14:17 UTC
bb9f2aecf0e212702cdb66e58b16e8e470e596cf
1 file changed
+3
Documentation/CodingGuidelines
+3
@@ -237,6 +237,9 @@ For Python scripts:
237
238
Writing Documentation:
239
240
+ Most (if not all) of the documentation pages are written in AsciiDoc
241
+ and processed into HTML output and manpages.
242
+
243
Every user-visible change should be reflected in the documentation.
244
The same general rule as for code applies -- imitate the existing
245
conventions. A few commented examples follow to provide reference