mirror of
https://github.com/git/git
synced 2024-08-23 18:00:25 +00:00
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>
This commit is contained in:
parent
92758dd2a2
commit
48bc1755b6
|
@ -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
|
||||
|
|
Loading…
Reference in a new issue