[Orca-checkins] rev 165 - trunk/orca

[blair at orcaware.com]

Author: blair
Date: 2002-11-16 10:28:22 -0800 (Sat, 16 Nov 2002)
New Revision: 165

Modified:
   trunk/orca/HACKING
Log:
* INSTALL:
  (Using page breaks): Fix a grammar mistake.
  (Writing log messages): Note that each file's entry in the log
    message starts with a "*".
  (Patch submission guidelines): Note that running "svn diff" will
    generate the diff file to send to the mailing list.


Modified: trunk/orca/HACKING
==============================================================================
--- trunk/orca/HACKING	(original)
+++ trunk/orca/HACKING	2002-11-16 10:28:56.000000000 -0800
@@ -157,8 +157,7 @@
 We're using page breaks (the Ctrl-L character, ASCII 12) for section
 boundaries in both code and plaintext prose files.  This file is a
 good example of how it's done: each section starts with a page break,
-and the immediately after the page break comes the title of the
-section.
+and immediately after the page break comes the title of the section.
 
 This helps out people who use the Emacs page commands, such as
 `pages-directory' and `narrow-to-page'.  Such people are not as scarce
@@ -240,11 +239,12 @@
 but only because the two structures were mentioned by full name
 elsewhere in the log entry.
 
-Note how each file gets its own entry, and the changes within a file
-are grouped by symbol, with the symbols are listed in parentheses
-followed by a colon, followed by text describing the change.  Please
-adhere to this format -- not only does consistency aid readability, it
-also allows software to colorize log entries automatically.
+Note how each file gets its own entry prefixed with an "*", and the
+changes within a file are grouped by symbol, with the symbols listed
+in parentheses followed by a colon, followed by text describing the
+change.  Please adhere to this format -- not only does consistency aid
+readability, it also allows software to colorize log entries
+automatically.
 
 If your change is related to a specific issue in the issue tracker,
 then include a string like "issue #N" in the log message.  For
@@ -332,13 +332,13 @@
 
 The email message should start off with a log message, as described in
 "Writing log messages" above.  The patch itself should be in unified
-diff format, preferably inserted directly into the body of your
-message (rather than MIME-attached, uuencoded, or otherwise
-opaqified).  If your mailer wraps long lines, then you will need to
-attach your patch.  Please ensure the MIME type of the attachment is
-text/plain (some mailers allow you to set the MIME type; for some
-others, you might have to use a .txt extension on your patch file). Do
-not compress or otherwise encode the attached patch.
+diff format (e.g., with "svn diff"), preferably inserted directly into
+the body of your message (rather than MIME-attached, uuencoded, or
+otherwise opaqified).  If your mailer wraps long lines, then you will
+need to attach your patch.  Please ensure the MIME type of the
+attachment is text/plain (some mailers allow you to set the MIME type;
+for some others, you might have to use a .txt extension on your patch
+file). Do not compress or otherwise encode the attached patch.
 
 If the patch implements a new feature, make sure to describe the
 feature completely in your mail; if the patch fixes a bug, describe