diff options
| author | Junio C Hamano <gitster@pobox.com> | 2013-03-21 14:17:32 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-03-21 14:17:32 -0700 |
| commit | bb9f2aecf0e212702cdb66e58b16e8e470e596cf (patch) | |
| tree | b6af6a90d1e48118558d363ef23f9299b02e1f22 | |
| parent | c9fc4415e2c7d7673cdad34d41114ede3435a395 (diff) | |
| download | git-bb9f2aecf0e212702cdb66e58b16e8e470e596cf.tar.gz | |
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>
| -rw-r--r-- | Documentation/CodingGuidelines | 3 |
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 |