summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFlorian Haas <florian@citynetwork.eu>2021-06-23 15:12:20 +0200
committerFlorian Haas <florian@citynetwork.eu>2021-06-24 12:06:12 +0200
commit04786cd9ea619203589cf8bed231e04059add266 (patch)
tree2f802f2aba0da50279936af591e66329add76046 /doc
parentc40eb491e651780e31e7e09d27d5cf333804cf19 (diff)
downloadgit-review-04786cd9ea619203589cf8bed231e04059add266.tar.gz
Doc updates for Git "core.hooksPath" option support
Couple of small follow-ups to Id8a3ac464ff75e6d8207f198089f018cc790eca5: * Fix formatting in the reno (use monospace as applicable). * Update "Installation and Configuration" to say that the local hook *normally* goes into .git/hooks. Change-Id: I1b326bdcaed38d3a82a65f944431f3640652dd33
Diffstat (limited to 'doc')
-rw-r--r--doc/source/installation.rst10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index 32fbf64..91c6a42 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -89,9 +89,13 @@ Hooks
git-review has a custom hook mechanism to run a script before certain
actions. This is done in the same spirit as the classic hooks in git.
-There are two types of hooks, a global one which is stored in
-``~/.config/git-review/hooks/`` and one local to the repository stored in
-``.git/hooks/`` with the other git hook scripts.
+There are two types of hooks:
+
+* a global one which is stored in ``~/.config/git-review/hooks/``,
+
+* and one local to the repository, which is stored with the other git
+ hook scripts. Normally that's the ``.git/hooks/`` directory in your
+ checkout.
**The script needs be executable before getting executed**