From: John Keeping <john@keeping.me.uk>
To: Orgad Shaneh <orgads@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: git gui replaces amend message when prepare-commit-msg hook is used
Date: Thu, 4 Jul 2013 12:19:01 +0100 [thread overview]
Message-ID: <20130704111901.GI9161@serenity.lan> (raw)
In-Reply-To: <CAGHpTB+ObJjqvQ-xfQOdGG+ZSZdCijVZXh1NBp97TZ=hO-QVgQ@mail.gmail.com>
On Thu, Jul 04, 2013 at 01:59:10PM +0300, Orgad Shaneh wrote:
> On Thu, Jul 4, 2013 at 1:34 PM, John Keeping <john@keeping.me.uk> wrote:
> > On Thu, Jul 04, 2013 at 12:47:28PM +0300, Orgad Shaneh wrote:
> >> Hi,
> >>
> >> If a prepare-commit-msg hook is used, git gui executes it for "New Commit".
> >>
> >> If the "New Commit" is selected, and then immediately "Amend" (before
> >> the hook returns), when the hook returns the message is replaced with
> >> the one produced by the hook.
> >
> > I think this is a problem with the hook you are running. The hook is
> > given arguments specifying the message file and optionally the source of
> > whatever is already in the file (see githooks(5) for details).
> >
> > It sounds like your hook is blindly overwriting the file, rather than
> > preserving its contents in the cases where you wish to do so.
>
> Let me try to explain.
>
> When git gui is executed, it calls the prepare-commit-msg script with
> .git/PREPARE_COMMIT_MSG as an argument.
>
> When amend is selected, the hook is *not* called at all (what would it
> prepare? The message is already committed)
>
> Use the following hook to reproduce:
> --- snip ---
> #!/bin/sh
>
> sleep 5
> echo "$@" >> /tmp/hook.log
> echo 'Hello hook' > "$1"
> --- snip ---
>
> Now run git gui (or press F5 if it is already running), and before 5
> seconds pass, click Amend last commit. You'll see the commit's
> message, but when the 5 seconds pass it is replaced with "Hello hook".
> That's the bug.
Yes, and that's a bug in the hook. The hook is called with a second
argument "commit" but it is ignoring this and blindly overwriting the
message. githooks(5) says:
prepare-commit-msg
This hook is invoked by git commit right after preparing the default
log message, and before the editor is started.
It takes one to three parameters. The first is the name of the
file that contains the commit log message. The second is the
source of the commit message, and can be: message (if a -m or -F
option was given); template (if a -t option was given or the
configuration option commit.template is set); merge (if the
commit is a merge or a .git/MERGE_MSG file exists); squash (if a
.git/SQUASH_MSG file exists); or commit, followed by a commit
SHA1 (if a -c, -C or --amend option was given).
If the exit status is non-zero, git commit will abort.
The purpose of the hook is to edit the message file in place,
and it is not suppressed by the --no-verify option. A non-zero
exit means a failure of the hook and aborts the commit. It
should not be used as replacement for pre-commit hook.
Your problem is that your hook script is not checking $2 so it is
overwriting the message even when you do not want to do so.
next prev parent reply other threads:[~2013-07-04 11:19 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-07-04 9:47 git gui replaces amend message when prepare-commit-msg hook is used Orgad Shaneh
2013-07-04 10:01 ` Fredrik Gustafsson
2013-07-04 10:03 ` Orgad Shaneh
2013-07-04 10:21 ` Fredrik Gustafsson
2013-07-04 10:34 ` John Keeping
2013-07-04 10:59 ` Orgad Shaneh
2013-07-04 11:17 ` Fredrik Gustafsson
2013-07-04 11:19 ` John Keeping [this message]
2013-07-04 11:37 ` Orgad Shaneh
2013-07-04 12:42 ` Antoine Pelisse
2013-07-04 12:46 ` Orgad Shaneh
2013-07-05 19:13 ` Antoine Pelisse
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20130704111901.GI9161@serenity.lan \
--to=john@keeping.me.uk \
--cc=git@vger.kernel.org \
--cc=orgads@gmail.com \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).