Skip to content

Commit bb9f2ae

Browse files
committed
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 <[email protected]>
1 parent c9fc441 commit bb9f2ae

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

Documentation/CodingGuidelines

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,9 @@ For Python scripts:
237237

238238
Writing Documentation:
239239

240+
Most (if not all) of the documentation pages are written in AsciiDoc
241+
and processed into HTML output and manpages.
242+
240243
Every user-visible change should be reflected in the documentation.
241244
The same general rule as for code applies -- imitate the existing
242245
conventions. A few commented examples follow to provide reference

0 commit comments

Comments
 (0)