Skip to content

Commit

Permalink
Merge branch 'dw/asciidoc-sources-are-dot-txt-files'
Browse files Browse the repository at this point in the history
* dw/asciidoc-sources-are-dot-txt-files:
  CodingGuidelines: Documentation/*.txt are the sources
  • Loading branch information
Junio C Hamano committed May 17, 2013
2 parents e86d0a3 + 48bc175 commit 8639f3e
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions Documentation/CodingGuidelines
Original file line number Diff line number Diff line change
Expand Up @@ -237,8 +237,10 @@ For Python scripts:

Writing Documentation:

Most (if not all) of the documentation pages are written in AsciiDoc
and processed into HTML output and manpages.
Most (if not all) of the documentation pages are written in the
AsciiDoc format in *.txt files (e.g. Documentation/git.txt), and
processed into HTML and manpages (e.g. git.html and git.1 in the
same directory).

Every user-visible change should be reflected in the documentation.
The same general rule as for code applies -- imitate the existing
Expand Down

0 comments on commit 8639f3e

Please sign in to comment.