]> git.ipfire.org Git - thirdparty/git.git/commitdiff
CodingGuidelines: Documentation/*.txt are the sources
authorDale Worley <worley@ariadne.com>
Tue, 7 May 2013 17:39:46 +0000 (13:39 -0400)
committerJunio C Hamano <gitster@pobox.com>
Fri, 10 May 2013 19:13:08 +0000 (12:13 -0700)
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>
Documentation/CodingGuidelines

index 7e4d5716a62bf59e8f072163ebac3064dad323ae..559d5f9ebf6fefe57b403327ed3e06942d0b822b 100644 (file)
@@ -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