From bb9f2aecf0e212702cdb66e58b16e8e470e596cf Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Thu, 21 Mar 2013 14:17:32 -0700 Subject: [PATCH] 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 --- Documentation/CodingGuidelines | 3 +++ 1 file changed, 3 insertions(+) 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