diff options
| author | Florian Haas <florian@citynetwork.eu> | 2021-06-23 15:12:20 +0200 |
|---|---|---|
| committer | Florian Haas <florian@citynetwork.eu> | 2021-06-24 12:06:12 +0200 |
| commit | 04786cd9ea619203589cf8bed231e04059add266 (patch) | |
| tree | 2f802f2aba0da50279936af591e66329add76046 | |
| parent | c40eb491e651780e31e7e09d27d5cf333804cf19 (diff) | |
| download | git-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
| -rw-r--r-- | doc/source/installation.rst | 10 | ||||
| -rw-r--r-- | releasenotes/notes/support-core-hooks-path-ea5402d5d6204f70.yaml | 10 |
2 files changed, 12 insertions, 8 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** diff --git a/releasenotes/notes/support-core-hooks-path-ea5402d5d6204f70.yaml b/releasenotes/notes/support-core-hooks-path-ea5402d5d6204f70.yaml index 0fa36a3..9f9e45b 100644 --- a/releasenotes/notes/support-core-hooks-path-ea5402d5d6204f70.yaml +++ b/releasenotes/notes/support-core-hooks-path-ea5402d5d6204f70.yaml @@ -1,8 +1,8 @@ --- fixes: - | - git-review now handles the Git "core.hooksPath" configuration - option correctly. Thus, it installs the commit-msg hook into the - core.hooksPath directory, if that option is set. Otherwise, it - continues to install the hook into .git/hooks, relative to the - root of the checkout. + git-review now handles the Git ``core.hooksPath`` configuration + option correctly. Thus, it installs the ``commit-msg`` hook into + the ``core.hooksPath`` directory, if that option is + set. Otherwise, it continues to install the hook into + ``.git/hooks``, relative to the root of the checkout. |