Skip to content

Commit

Permalink
CodingGuidelines: our documents are in AsciiDoc
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Junio C Hamano committed Mar 21, 2013
1 parent c9fc441 commit bb9f2ae
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions Documentation/CodingGuidelines
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit bb9f2ae

Please sign in to comment.