diff options
| author | Junio C Hamano <gitster@pobox.com> | 2013-05-17 23:16:44 +0400 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-05-17 23:16:44 +0400 |
| commit | 8639f3e49f89525931c86048e81751b05c3923ac (patch) | |
| tree | 8a27406e1c2ff8f751d99892f95e34de5d3816c0 | |
| parent | e86d0a37b48df74d99d071d4642519bdebf08990 (diff) | |
| parent | 48bc1755b654cbcc3a48476995d2421580ddd2a5 (diff) | |
Merge branch 'dw/asciidoc-sources-are-dot-txt-files'
* dw/asciidoc-sources-are-dot-txt-files:
CodingGuidelines: Documentation/*.txt are the sources
| -rw-r--r-- | Documentation/CodingGuidelines | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 7e4d5716a6..559d5f9ebf 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -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 |