# [PATCHv3] CodingGuidelines: Documentation/*.txt are the sources 1 messages from 2013-05-07 to 2013-05-07. Participants: Dale Worley. Thread: https://gitlist.dev/t/33775 ## Dale Worley, 2013-05-07 17:39 Subject: [PATCHv3] CodingGuidelines: Documentation/*.txt are the sources Message-ID: <201305101823.r4AINj1k018204@freeze.ariadne.com> URL: https://gitlist.dev/e/201305101823.r4AINj1k018204%40freeze.ariadne.com ``` 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 --- Documentation/CodingGuidelines | 6 ++++-- 1 files changed, 4 insertions(+), 2 deletions(-) diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 7e4d571..559d5f9 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 -- 1.7.7.6 ```