{"thread":{"id":"33741","subject":"[PATCH] CodingGuidelines: make it clear which files in Documentation are the sources","startedAt":"2013-05-07T17:52:58Z","lastAt":"2013-05-07T18:03:29Z","messageCount":2,"participants":["Dale R. Worley","Matthieu Moy"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"216630","messageId":"201305071752.r47HqwxR001058@hobgoblin.ariadne.com","threadId":"33741","inReplyTo":null,"subject":"[PATCH] CodingGuidelines: make it clear which files in Documentation are the sources","fromName":"Dale R. Worley","fromEmail":"worley@ariadne.com","sentAt":"2013-05-07T17:52:58Z","receivedAt":"2013-05-07T17:52:58Z","isPatch":true,"sender":{"key":"worley@ariadne.com","avatar":null},"body":"While learning about making a documentation patch, I noticed that\nDocumentation/CodingGuideles isn't as clear as it could be regarding\nhow to edit the documentation.  In particular, it says \"Most (if not\nall) of the documentation pages are written in AsciiDoc - and\nprocessed into HTML output and manpages.\" without really specifying\nthe details for those of us who aren't familiar with AsciiDoc.  So I\nadded a sentence stating explicitly which files are the sources and\nwhich are derived.\n\nIt's also a test for submitting a patch.\n\nDale\n\n\n\n>From e87227498ef3d50dc20584c24c53071cce63c555 Mon Sep 17 00:00:00 2001\nFrom: Dale Worley <worley@ariadne.com>\nDate: Tue, 7 May 2013 13:39:46 -0400\nSubject: [PATCH] CodingGuidelines:  make it clear which files in\n Documentation are the sources\n\n---\n Documentation/CodingGuidelines |    4 +++-\n 1 files changed, 3 insertions(+), 1 deletions(-)\n\ndiff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines\nindex 7e4d571..b8eef7c 100644\n--- a/Documentation/CodingGuidelines\n+++ b/Documentation/CodingGuidelines\n@@ -238,7 +238,9 @@ For Python scripts:\n Writing Documentation:\n \n  Most (if not all) of the documentation pages are written in AsciiDoc\n- and processed into HTML output and manpages.\n+ and processed into HTML output and manpages.  This means that the *.txt\n+ files in this directory are usually the sources from which the\n+ corresponding *.html, *.1, and *.xml files are generated.\n \n  Every user-visible change should be reflected in the documentation.\n  The same general rule as for code applies -- imitate the existing\n-- \n1.7.7.6\n"},{"id":"216631","messageId":"vpqfvxyllam.fsf@grenoble-inp.fr","threadId":"33741","inReplyTo":"201305071752.r47HqwxR001058@hobgoblin.ariadne.com","subject":"Re: [PATCH] CodingGuidelines: make it clear which files in Documentation are the sources","fromName":"Matthieu Moy","fromEmail":"matthieu.moy@grenoble-inp.fr","sentAt":"2013-05-07T18:03:29Z","receivedAt":"2013-05-07T18:03:29Z","isPatch":true,"sender":{"key":"matthieu.moy@grenoble-inp.fr","avatar":"https://gravatar.com/avatar/72c8a2705971a25dfaff23cece15130d405685845d911aedd5667ace277f3fc5?d=mp&s=160"},"body":"worley@ariadne.com (Dale R. Worley) writes:\n\n> It's also a test for submitting a patch.\n\nThen, the next step is to read SubmittingPatches (the part about how to\nformat your email and the role of the ---, and the part about\nsigned-off-by) ;-).\n\nWelcome aboard!\n\n-- \nMatthieu Moy\nhttp://www-verimag.imag.fr/~moy/\n"}]}