Re: [PATCH 1/1] devel/STYLE: information how to enable standard pre-commit hook

diff --git a/80/07cef980ec864e4c0578c0bdddfa3187bd3e20 b/80/07cef980ec864e4c0578c0bdddfa3187bd3e20
new file mode 100644 (file)
index 0000000..6783b04
--- /dev/null
+++ b/80/07cef980ec864e4c0578c0bdddfa3187bd3e20
@@ -0,0 +1,113 @@
+Return-Path: <tomi.ollila@iki.fi>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id BD767431FB6\r
+       for <notmuch@notmuchmail.org>; Tue, 26 Mar 2013 02:30:43 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.644\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.644 tagged_above=-999 required=5\r
+       tests=[URIBL_SBL=0.644] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id wM+F+A8r+Gny for <notmuch@notmuchmail.org>;\r
+       Tue, 26 Mar 2013 02:30:43 -0700 (PDT)\r
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id E1D84431FAF\r
+       for <notmuch@notmuchmail.org>; Tue, 26 Mar 2013 02:30:42 -0700 (PDT)\r
+Received: from guru.guru-group.fi (localhost [IPv6:::1])\r
+       by guru.guru-group.fi (Postfix) with ESMTP id DCB8A100033;\r
+       Tue, 26 Mar 2013 11:30:30 +0200 (EET)\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: Jani Nikula <jani@nikula.org>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH 1/1] devel/STYLE: information how to enable standard\r
+       pre-commit hook\r
+In-Reply-To: <87ppymfrjg.fsf@nikula.org>\r
+References: <1364040435-22357-1-git-send-email-tomi.ollila@iki.fi>\r
+       <87ppymfrjg.fsf@nikula.org>\r
+User-Agent: Notmuch/0.15.2+50~g43fdda5 (http://notmuchmail.org) Emacs/24.2.1\r
+       (x86_64-unknown-linux-gnu)\r
+X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
+       $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
+       !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
+Date: Tue, 26 Mar 2013 11:30:30 +0200\r
+Message-ID: <m2li9apky1.fsf@guru.guru-group.fi>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Tue, 26 Mar 2013 09:30:43 -0000\r
+\r
+On Tue, Mar 26 2013, Jani Nikula <jani@nikula.org> wrote:\r
+\r
+> On Sat, 23 Mar 2013, Tomi Ollila <tomi.ollila@iki.fi> wrote:\r
+>> It is easier to enable git standard pre-commit hook, when the\r
+>> operation to do so is presented.\r
+>> ---\r
+>>  devel/STYLE | 5 +++--\r
+>>  1 file changed, 3 insertions(+), 2 deletions(-)\r
+>>\r
+>> diff --git a/devel/STYLE b/devel/STYLE\r
+>> index 0792ba1..92de42c 100644\r
+>> --- a/devel/STYLE\r
+>> +++ b/devel/STYLE\r
+>> @@ -45,8 +45,9 @@ function (param_type param, param_type param)\r
+>>     - likewise, there is a space following keywords such as if and while\r
+>>     - every binary operator should have space on either side.\r
+>>  \r
+>> -* No trailing whitespace. Please enable the standard pre-commit hook\r
+>> -  in git (or an equivalent hook).\r
+>> +* No trailing whitespace. Please enable the standard pre-commit hook in git\r
+>> +  (or an equivalent hook). The standard pre-commit hook is enabled by simply\r
+>> +  renaming file '.git/hooks/pre-commit.sample' to '.git/hooks/pre-commit' .\r
+>\r
+> <bikeshedding>\r
+>\r
+> Or just refer to http://git-scm.com/book/en/Customizing-Git-Git-Hooks or\r
+> man githooks if you really need to. Older versions of git used to have\r
+> properly named hooks with the executable bit unset...\r
+\r
+True, older versions used different convention. I presume minority of\r
+users have such an old version.\r
+\r
+Just this minor indirection will make many users skip the activation of\r
+the hook as it requires more effort to find the information; I belong\r
+to this group of people; I prefer super simple instructions :D\r
+\r
+> Personally I wouldn't ask anyone to enable the hook because I wouldn't\r
+> enable it in the first place. There's $EDITOR and 'git diff --check' to\r
+> do that kind of thing... When I want to commit I want to commit, warts\r
+> and all, and I don't want a hook to prevent me from doing so!\r
+\r
+git commit -n (or --no-verify) will bypass the hooks. I have the hook\r
+enabled (in fact I was surprised that it was) and I don't recall a case\r
+when I had to resort to -n option (or edit the content to make the\r
+commit pass the hook).\r
+\r
+> </bikeshedding>\r
+\r
+So, my point is that if there is clear-enough way to inform majority\r
+of users how to enable hook users will do it; the hook helps users\r
+to provide more compliant code (and, more importantantly, less review\r
+comments about whitespace problems) andd in case there is need to bypass\r
+the check that is also easy to do -- more documentation about bypassing\r
+check could be added, though (I'll do it if this change get supporters...).\r
+\r
+>\r
+> BR,\r
+> Jani.\r
+\r
+\r
+Tomi\r