Re: [PATCH] Removed redundant static functions such as update_tracking_ref() and verify_remote_names() from builtin-send-pack.c, and made the ones in transport.c not be static so they can be used instead.

From

Sam Vilain <sam@vilain.net>

Date

Apr 27, 2009, 14:38 UTC

Message-ID

<49F5C377.9010200@vilain.net>

In-Reply-To

<4B2541E8-7A27-45D5-B77D-AE93C0430EA8@petdance.com>

Andy Lester wrote:

> > I dunno.  The most important part of CodingGuidelines is this:
> >     As for more concrete guidelines, just imitate the existing code
> >     (this is a good guideline, no matter which project you are
> >     contributing to).
> > (And of course, this holds for the style of commit messages, too.)
> Would you rather I not bother?  Far be it from me to try to force
> myself on any project.

Bother?  What bother?  Do you think we're kidding? :-)

Subject: [PATCH] SubmittingPatches: itemize and reflect upon well written changes

Signed-off-by: Sam Vilain <sam@vilain.net>
---
 <insert funny meta-circular joke here>

 Documentation/SubmittingPatches |   14 +++++++++++++-
 1 files changed, 13 insertions(+), 1 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 8d818a2..76fc84d 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -6,9 +6,13 @@ Checklist (and a short version for the impatient):
 	- check for unnecessary whitespace with "git diff --check"
 	  before committing
 	- do not check in commented out code or unneeded files
-	- provide a meaningful commit message
 	- the first line of the commit message should be a short
 	  description and should skip the full stop
+	- the body should provide a meaningful commit message, which:
+		- uses the imperative, present tense: "change",
+		  not "changed" or "changes".
+		- includes motivation for the change, and contrasts
+		  its implementation with previous behaviour
 	- if you want your work included in git.git, add a
 	  "Signed-off-by: Your Name <you@example.com>" line to the
 	  commit message (or just use the option "-s" when
@@ -62,6 +66,14 @@ Describe the technical detail of the change(s).
 
 If your description starts to get too long, that's a sign that you
 probably need to split up your commit to finer grained pieces.
+That being said, patches which plainly describe the things that
+help reviewers check the patch, and future maintainers understand
+the code, are the most beautiful patches.  Descriptions that summarise
+the point in the subject well, and describe the motivation for the
+change, the approach taken by the change, and if relevant how this
+differs substantially from the prior version, can be found on Usenet
+archives back into the late 80's.  Consider it like good Netiquette,
+but for code.
 
 Oh, another thing.  I am picky about whitespaces.  Make sure your
 changes do not trigger errors with the sample pre-commit hook shipped

-- 
1.6.2.234.g28eec