linux-kernel - Re: [PATCH 1/3] SubmittingPatches: Add style recommendation to use imperative descriptions

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20131215211429.GA32667@pd.tnic>
Date:	Sun, 15 Dec 2013 22:14:29 +0100
From:	Borislav Petkov <bp@...en8.de>
To:	Josh Triplett <josh@...htriplett.org>
Cc:	linux-kernel@...r.kernel.org, linux-doc@...r.kernel.org,
	Rob Landley <rob@...dley.net>
Subject: Re: [PATCH 1/3] SubmittingPatches: Add style recommendation to use
 imperative descriptions

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@...htriplett.org>

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