git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: David Cowden <dcow90@gmail.com>
To: git@vger.kernel.org
Cc: David Cowden <dcow90@gmail.com>
Subject: [PATCH] Clarify pre-push hook documentation
Date: Sun, 23 Mar 2014 12:08:29 -0700	[thread overview]
Message-ID: <1395601709-78479-1-git-send-email-dcow90@gmail.com> (raw)
In-Reply-To: <1395601267-78377-1-git-send-email-dcow90@gmail.com>

The documentation as-is does not mention that the pre-push hook is
executed even when there is nothing to push.  This can lead a new
reader to beilieve there will always be lines fed to the script's
standerd input and cause minor confusion as to what is happening
when there are no lines provided to the pre-push script.

Signed-off-by: David Cowden <dcow90@gmail.com>
---

Notes:
    c.f. http://stackoverflow.com/questions/22585091/git-hooks-pre-push-script-does-not-receive-input-via-stdin

 Documentation/githooks.txt | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
index d954bf6..a28f6f7 100644
--- a/Documentation/githooks.txt
+++ b/Documentation/githooks.txt
@@ -203,6 +203,10 @@ SHA-1>` will be 40 `0`.  If the local commit was specified by something other
 than a name which could be expanded (such as `HEAD~`, or a SHA-1) it will be
 supplied as it was originally given.
 
+The hook is executed regardless of whether there are changes to push or not.
+In the event that there are no changes, no data will be provided on the
+script's standard input.
+
 If this hook exits with a non-zero status, 'git push' will abort without
 pushing anything.  Information about why the push is rejected may be sent
 to the user by writing to standard error.
-- 
1.9.1

  reply	other threads:[~2014-03-23 19:22 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-03-23 19:01 [PATCH] Clarify pre-push hook documentation David Cowden
2014-03-23 19:08 ` David Cowden [this message]
2014-03-23 20:12   ` Junio C Hamano
2014-03-23 19:18 ` David Cowden
2014-03-24  1:40 ` Eric Sunshine
2014-03-24 23:43 ` [PATCH v2] " David Cowden
2014-03-24 23:51   ` [PATCH v3] " David Cowden
2014-03-25 17:11     ` Junio C Hamano
2014-03-26 23:21       ` Philip Oakley
2014-04-08  8:43         ` David Cowden

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1395601709-78479-1-git-send-email-dcow90@gmail.com \
    --to=dcow90@gmail.com \
    --cc=git@vger.kernel.org \
    /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.
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 NNTP newsgroup(s).