Re: [PATCH 1/3] SubmittingPatches: Add style recommendation to useimperative descriptions

From: Borislav Petkov
Date: Sun Dec 15 2013 - 16:14:41 EST


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@xxxxxxxxxxxxxxxx>

Acked-by: Borislav Petkov <bp@xxxxxxx>

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.
--
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/