[PATCH] CodingGuidelines: make it clear which files in Documentation are the sources

From: Dale R. Worley <worley@ariadne.com>
Date: May 7, 2013, 17:52 UTC
Message-ID: <201305071752.r47HqwxR001058@hobgoblin.ariadne.com>

While learning about making a documentation patch, I noticed that Documentation/CodingGuideles isn't as clear as it could be regarding how to edit the documentation. In particular, it says "Most (if not all) of the documentation pages are written in AsciiDoc - and processed into HTML output and manpages." without really specifying the details for those of us who aren't familiar with AsciiDoc. So I added a sentence stating explicitly which files are the sources and which are derived.

It's also a test for submitting a patch.

Dale

>From e87227498ef3d50dc20584c24c53071cce63c555 Mon Sep 17 00:00:00 2001

From: Dale Worley <worley@ariadne.com>
Date: Tue, 7 May 2013 13:39:46 -0400
Subject: [PATCH] CodingGuidelines:  make it clear which files in
 Documentation are the sources

---
 Documentation/CodingGuidelines |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 7e4d571..b8eef7c 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -238,7 +238,9 @@ For Python scripts:
 Writing Documentation:
 
  Most (if not all) of the documentation pages are written in AsciiDoc
- and processed into HTML output and manpages.
+ and processed into HTML output and manpages.  This means that the *.txt
+ files in this directory are usually the sources from which the
+ corresponding *.html, *.1, and *.xml files are generated.
 
  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