diff options
| author | Dale Worley <worley@ariadne.com> | 2013-05-07 13:39:46 -0400 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-05-10 12:13:08 -0700 |
| commit | 48bc1755b654cbcc3a48476995d2421580ddd2a5 (patch) | |
| tree | 1beb18ca4a9702847ef6dbff2f81a3778b4ff124 | |
| parent | 92758dd2a2de94c90c0697ef0e8174c3543a47f9 (diff) | |
| download | git-48bc1755b654cbcc3a48476995d2421580ddd2a5.tar.gz git-48bc1755b654cbcc3a48476995d2421580ddd2a5.tar.xz | |
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>
| -rw-r--r-- | Documentation/CodingGuidelines | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 7e4d5716a..559d5f9eb 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 |