Skip to content

Commit

Permalink
CodingGuidelines: Documentation/*.txt are the sources
Browse files Browse the repository at this point in the history
People not familiar with AsciiDoc may not realize they are
supposed to update *.txt files and not *.html/*.1 files when
preparing patches to the project.

Signed-off-by: Dale Worley <worley@ariadne.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Dale Worley authored and Junio C Hamano committed May 10, 2013
1 parent 92758dd commit 48bc175
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 48bc175

Please sign in to comment.