Skip to content

Commit 48bc175

Browse files
Dale Worleygitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 92758dd commit 48bc175

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

Documentation/CodingGuidelines

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -237,8 +237,10 @@ For Python scripts:
237237

238238
Writing Documentation:
239239

240-
Most (if not all) of the documentation pages are written in AsciiDoc
241-
and processed into HTML output and manpages.
240+
Most (if not all) of the documentation pages are written in the
241+
AsciiDoc format in *.txt files (e.g. Documentation/git.txt), and
242+
processed into HTML and manpages (e.g. git.html and git.1 in the
243+
same directory).
242244

243245
Every user-visible change should be reflected in the documentation.
244246
The same general rule as for code applies -- imitate the existing

0 commit comments

Comments
 (0)