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