opendev/git-review
Code Issues Proposed changes

Doc updates for Git "core.hooksPath" option support

Browse Source 
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
This commit is contained in:
Florian Haas 2021-06-23 15:12:20 +02:00
parent c40eb491e6
commit 04786cd9ea
2 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/installation.rst
View File

@ -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**

10
releasenotes/notes/support-core-hooks-path-ea5402d5d6204f70.yaml
View File

@ -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.