From f98f8cbac01e0d5dbb30660d7ea70af6a1439dfd Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Tue, 24 Jun 2008 18:45:21 -0700 Subject: [PATCH] Ship sample hooks with .sample suffix We used to mark hooks we ship as samples by making them unexecutable, but some filesystems cannot tell what is executable and what is not. This makes it much more explicit. The hooks are suffixed with .sample (but now are made executable), so enabling it is still one step operation (instead of "chmod +x $hook", you would do "mv $hook.sample $hook") but now they won't get accidentally enabled on systems without executable bit. Signed-off-by: Junio C Hamano --- Documentation/githooks.txt | 3 ++- ...ooks--applypatch-msg => hooks--applypatch-msg.sample} | 2 +- .../{hooks--commit-msg => hooks--commit-msg.sample} | 2 +- .../{hooks--post-commit => hooks--post-commit.sample} | 2 +- templates/hooks--post-receive | 16 ---------------- templates/hooks--post-receive.sample | 15 +++++++++++++++ .../{hooks--post-update => hooks--post-update.sample} | 2 +- ...ooks--pre-applypatch => hooks--pre-applypatch.sample} | 2 +- .../{hooks--pre-commit => hooks--pre-commit.sample} | 2 +- .../{hooks--pre-rebase => hooks--pre-rebase.sample} | 0 ...epare-commit-msg => hooks--prepare-commit-msg.sample} | 2 +- templates/{hooks--update => hooks--update.sample} | 2 +- 12 files changed, 25 insertions(+), 25 deletions(-) rename templates/{hooks--applypatch-msg => hooks--applypatch-msg.sample} (86%) mode change 100644 => 100755 rename templates/{hooks--commit-msg => hooks--commit-msg.sample} (93%) mode change 100644 => 100755 rename templates/{hooks--post-commit => hooks--post-commit.sample} (63%) mode change 100644 => 100755 delete mode 100644 templates/hooks--post-receive create mode 100755 templates/hooks--post-receive.sample rename templates/{hooks--post-update => hooks--post-update.sample} (63%) mode change 100644 => 100755 rename templates/{hooks--pre-applypatch => hooks--pre-applypatch.sample} (84%) mode change 100644 => 100755 rename templates/{hooks--pre-commit => hooks--pre-commit.sample} (96%) mode change 100644 => 100755 rename templates/{hooks--pre-rebase => hooks--pre-rebase.sample} (100%) mode change 100644 => 100755 rename templates/{hooks--prepare-commit-msg => hooks--prepare-commit-msg.sample} (94%) mode change 100644 => 100755 rename templates/{hooks--update => hooks--update.sample} (97%) mode change 100644 => 100755 diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt index 4f06ae0ed4..262a4f1626 100644 --- a/Documentation/githooks.txt +++ b/Documentation/githooks.txt @@ -17,7 +17,8 @@ Hooks are little scripts you can place in `$GIT_DIR/hooks` directory to trigger action at certain points. When `git-init` is run, a handful example hooks are copied in the `hooks` directory of the new repository, but by default they are -all disabled. To enable a hook, make it executable with `chmod +x`. +all disabled. To enable a hook, rename it by removing its `.sample` +suffix. This document describes the currently defined hooks. diff --git a/templates/hooks--applypatch-msg b/templates/hooks--applypatch-msg.sample old mode 100644 new mode 100755 similarity index 86% rename from templates/hooks--applypatch-msg rename to templates/hooks--applypatch-msg.sample index 02de1ef84c..8b2a2fe84f --- a/templates/hooks--applypatch-msg +++ b/templates/hooks--applypatch-msg.sample @@ -7,7 +7,7 @@ # appropriate message if it wants to stop the commit. The hook is # allowed to edit the commit message file. # -# To enable this hook, make this file executable. +# To enable this hook, rename this file to "applypatch-msg". . git-sh-setup test -x "$GIT_DIR/hooks/commit-msg" && diff --git a/templates/hooks--commit-msg b/templates/hooks--commit-msg.sample old mode 100644 new mode 100755 similarity index 93% rename from templates/hooks--commit-msg rename to templates/hooks--commit-msg.sample index 4ef86eb244..6ef1d29d09 --- a/templates/hooks--commit-msg +++ b/templates/hooks--commit-msg.sample @@ -6,7 +6,7 @@ # status after issuing an appropriate message if it wants to stop the # commit. The hook is allowed to edit the commit message file. # -# To enable this hook, make this file executable. +# To enable this hook, rename this file to "commit-msg". # Uncomment the below to add a Signed-off-by line to the message. # Doing this in a hook is a bad idea in general, but the prepare-commit-msg diff --git a/templates/hooks--post-commit b/templates/hooks--post-commit.sample old mode 100644 new mode 100755 similarity index 63% rename from templates/hooks--post-commit rename to templates/hooks--post-commit.sample index 8be6f34ad9..22668216a3 --- a/templates/hooks--post-commit +++ b/templates/hooks--post-commit.sample @@ -3,6 +3,6 @@ # An example hook script that is called after a successful # commit is made. # -# To enable this hook, make this file executable. +# To enable this hook, rename this file to "post-commit". : Nothing diff --git a/templates/hooks--post-receive b/templates/hooks--post-receive deleted file mode 100644 index b70c8fd364..0000000000 --- a/templates/hooks--post-receive +++ /dev/null @@ -1,16 +0,0 @@ -#!/bin/sh -# -# An example hook script for the post-receive event -# -# This script is run after receive-pack has accepted a pack and the -# repository has been updated. It is passed arguments in through stdin -# in the form -# -# For example: -# aa453216d1b3e49e7f6f98441fa56946ddcd6a20 68f7abf4e6f922807889f52bc043ecd31b79f814 refs/heads/master -# -# see contrib/hooks/ for an sample, or uncomment the next line (on debian) -# - - -#. /usr/share/doc/git-core/contrib/hooks/post-receive-email diff --git a/templates/hooks--post-receive.sample b/templates/hooks--post-receive.sample new file mode 100755 index 0000000000..18d2e0f727 --- /dev/null +++ b/templates/hooks--post-receive.sample @@ -0,0 +1,15 @@ +#!/bin/sh +# +# An example hook script for the "post-receive" event. +# +# The "post-receive" script is run after receive-pack has accepted a pack +# and the repository has been updated. It is passed arguments in through +# stdin in the form +# +# For example: +# aa453216d1b3e49e7f6f98441fa56946ddcd6a20 68f7abf4e6f922807889f52bc043ecd31b79f814 refs/heads/master +# +# see contrib/hooks/ for an sample, or uncomment the next line and +# rename the file to "post-receive". + +#. /usr/share/doc/git-core/contrib/hooks/post-receive-email diff --git a/templates/hooks--post-update b/templates/hooks--post-update.sample old mode 100644 new mode 100755 similarity index 63% rename from templates/hooks--post-update rename to templates/hooks--post-update.sample index bcba8937bb..5323b56b81 --- a/templates/hooks--post-update +++ b/templates/hooks--post-update.sample @@ -3,6 +3,6 @@ # An example hook script to prepare a packed repository for use over # dumb transports. # -# To enable this hook, make this file executable by "chmod +x post-update". +# To enable this hook, rename this file to "post-update". exec git-update-server-info diff --git a/templates/hooks--pre-applypatch b/templates/hooks--pre-applypatch.sample old mode 100644 new mode 100755 similarity index 84% rename from templates/hooks--pre-applypatch rename to templates/hooks--pre-applypatch.sample index eeccc934ca..b1f187c2e9 --- a/templates/hooks--pre-applypatch +++ b/templates/hooks--pre-applypatch.sample @@ -6,7 +6,7 @@ # The hook should exit with non-zero status after issuing an # appropriate message if it wants to stop the commit. # -# To enable this hook, make this file executable. +# To enable this hook, rename this file to "pre-applypatch". . git-sh-setup test -x "$GIT_DIR/hooks/pre-commit" && diff --git a/templates/hooks--pre-commit b/templates/hooks--pre-commit.sample old mode 100644 new mode 100755 similarity index 96% rename from templates/hooks--pre-commit rename to templates/hooks--pre-commit.sample index b25dce6bbf..71c10f25f4 --- a/templates/hooks--pre-commit +++ b/templates/hooks--pre-commit.sample @@ -5,7 +5,7 @@ # exit with non-zero status after issuing an appropriate message if # it wants to stop the commit. # -# To enable this hook, make this file executable. +# To enable this hook, rename this file to "pre-commit". # This is slightly modified from Andrew Morton's Perfect Patch. # Lines you introduce should not have trailing whitespace. diff --git a/templates/hooks--pre-rebase b/templates/hooks--pre-rebase.sample old mode 100644 new mode 100755 similarity index 100% rename from templates/hooks--pre-rebase rename to templates/hooks--pre-rebase.sample diff --git a/templates/hooks--prepare-commit-msg b/templates/hooks--prepare-commit-msg.sample old mode 100644 new mode 100755 similarity index 94% rename from templates/hooks--prepare-commit-msg rename to templates/hooks--prepare-commit-msg.sample index d3c1da34d2..aa42acfd68 --- a/templates/hooks--prepare-commit-msg +++ b/templates/hooks--prepare-commit-msg.sample @@ -7,7 +7,7 @@ # message file. If the hook fails with a non-zero status, # the commit is aborted. # -# To enable this hook, make this file executable. +# To enable this hook, rename this file to "prepare-commit-msg". # This hook includes three examples. The first comments out the # "Conflicts:" part of a merge commit. diff --git a/templates/hooks--update b/templates/hooks--update.sample old mode 100644 new mode 100755 similarity index 97% rename from templates/hooks--update rename to templates/hooks--update.sample index 4b69268fd0..93c605594f --- a/templates/hooks--update +++ b/templates/hooks--update.sample @@ -3,7 +3,7 @@ # An example hook script to blocks unannotated tags from entering. # Called by git-receive-pack with arguments: refname sha1-old sha1-new # -# To enable this hook, make this file executable by "chmod +x update". +# To enable this hook, rename this file to "update". # # Config # ------ -- 2.11.4.GIT