development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-08-23 18:00:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

CodingGuidelines: Documentation/*.txt are the sources

Browse source 
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>
This commit is contained in:
Dale Worley 2013-05-07 13:39:46 -04:00 committed by Junio C Hamano
parent 92758dd2a2
commit 48bc1755b6
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
Documentation/CodingGuidelines
View 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