Add missing documentation about hook configuration
Add documentation of hook config for `change-restored`, `ref-updated`
and `cla-signed` hooks.
Also fix a couple of minor formatting issues.
Change-Id: I9904f5ddf40002db2f85600dd089be2f3052594f
diff --git a/Documentation/config-gerrit.txt b/Documentation/config-gerrit.txt
index 5bda0a1..06d2f72 100644
--- a/Documentation/config-gerrit.txt
+++ b/Documentation/config-gerrit.txt
@@ -1195,6 +1195,21 @@
Optional filename for the change abandoned hook, if not specified then
`change-abandoned` will be used.
+[[hooks.changeRestoredHook]]hooks.changeRestoredHook::
++
+Optional filename for the change restored hook, if not specified then
+`change-restored` will be used.
+
+[[hooks.refUpdatedHook]]hooks.refUpdatedHook::
++
+Optional filename for the ref updated hook, if not specified then
+`ref-updated` will be used.
+
+[[hooks.claSignedHook]]hooks.claSignedHook::
++
+Optional filename for the CLA signed hook, if not specified then
+`cla-signed` will be used.
+
[[http]]Section http
~~~~~~~~~~~~~~~~~~~~
diff --git a/Documentation/config-hooks.txt b/Documentation/config-hooks.txt
index 7765e06..ec45837 100644
--- a/Documentation/config-hooks.txt
+++ b/Documentation/config-hooks.txt
@@ -24,7 +24,7 @@
~~~~~~~~~~~~~~~~
This is called whenever a patchset is created (this includes new
-changes)
+changes).
====
patchset-created --change <change id> --change-url <change url> --project <project name> --branch <branch> --uploader <uploader> --commit <sha1> --patchset <patchset id>
@@ -58,7 +58,7 @@
====
change-restored
-~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~
Called whenever a change has been restored.
@@ -76,9 +76,9 @@
====
cla-signed
-~~~~~~~~~~~
+~~~~~~~~~~
-Called whenever a user signs a contributor license agreement
+Called whenever a user signs a contributor license agreement.
====
cla-signed --submitter <submitter> --user-id <user_id> --cla-id <cla_id>
@@ -89,12 +89,13 @@
----------------------
It is possible to change where Gerrit looks for hooks, and what
-filenames it looks for by adding a [hooks] section to gerrit.config.
+filenames it looks for, by adding a [hooks] section in gerrit.config.
-Gerrit will use the value of hooks.path for the hooks directory, and
-the values of hooks.patchsetCreatedHook, hooks.commentAddedHook,
-hooks.changeMergedHook and hooks.changeAbandonedHook for the
-filenames for the hooks.
+Gerrit will use the value of hooks.path for the hooks directory.
+
+For the hook filenames, Gerrit will use the values of hooks.patchsetCreatedHook,
+hooks.commentAddedHook, hooks.changeMergedHook, hooks.changeAbandonedHook,
+hooks.changeRestoredHook, hooks.refUpdatedHook and hooks.claSignedHook.
Missing Change URLs
-------------------