From: Borislav Petkov <bp@alien8.de>
To: Josh Triplett <josh@joshtriplett.org>
Cc: linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
Rob Landley <rob@landley.net>
Subject: Re: [PATCH 1/3] SubmittingPatches: Add style recommendation to use imperative descriptions
Date: Sun, 15 Dec 2013 22:14:29 +0100 [thread overview]
Message-ID: <20131215211429.GA32667@pd.tnic> (raw)
In-Reply-To: <20131215205925.GA11106@leaf>
On Sun, Dec 15, 2013 at 12:59:26PM -0800, Josh Triplett wrote:
> Most commit messages use this style, and the recommendation frequently
> comes up in discussions (especially in response to patches that don't
> use it), but that recommendation doesn't actually appear anywhere in
> Documentation. Add this style guideline to SubmittingPatches, using the
> description from git's SubmittingPatches.
>
> Signed-off-by: Josh Triplett <josh@joshtriplett.org>
Acked-by: Borislav Petkov <bp@suse.de>
We should probably also document the wished-for structure of a commit
message:
The current situation is A. The shortcoming is B. Change/fix it by doing
C.
This helps very much in explaining to the unenlightened onlooker what
a patch is trying to fix without having to ask the author a bunch of
questions first.
--
Regards/Gruss,
Boris.
Sent from a fat crate under my desk. Formatting is fine.
--
next prev parent reply other threads:[~2013-12-15 21:14 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-12-15 20:59 [PATCH 1/3] SubmittingPatches: Add style recommendation to use imperative descriptions Josh Triplett
2013-12-15 21:14 ` Borislav Petkov [this message]
2013-12-15 22:05 ` Josh Triplett
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20131215211429.GA32667@pd.tnic \
--to=bp@alien8.de \
--cc=josh@joshtriplett.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rob@landley.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox