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

Merge branch 'dw/asciidoc-sources-are-dot-txt-files'

Browse source 
* dw/asciidoc-sources-are-dot-txt-files:
  CodingGuidelines: Documentation/*.txt are the sources
This commit is contained in:
Junio C Hamano 2013-05-17 12:16:44 -07:00
parent e86d0a37b4 48bc1755b6
commit 8639f3e49f
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