CodingGuidelines: Documentation/*.txt are the sources
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>
Dale Worley committed
May 7, 2013 at 13:39 UTC
48bc1755b654cbcc3a48476995d2421580ddd2a5
1 file changed
+4
-2
Documentation/CodingGuidelines
+4
-2
@@ -237,8 +237,10 @@ For Python scripts:
237
238
Writing Documentation:
239
240
- Most (if not all) of the documentation pages are written in AsciiDoc
241
- and processed into HTML output and manpages.
240
+ Most (if not all) of the documentation pages are written in the
241
+ AsciiDoc format in *.txt files (e.g. Documentation/git.txt), and
242
+ processed into HTML and manpages (e.g. git.html and git.1 in the
243
+ same directory).
244
245
Every user-visible change should be reflected in the documentation.
246
The same general rule as for code applies -- imitate the existing