Merge branch 'stable-2.14' into stable-2.15
* stable-2.14:
Add README
Reword introduction in configuration documentation
Fix formatting in configuration documentation
Improve the "about" page
Change-Id: I416f37eb11ede961f2b7afbcf0a47f79ce9fc906
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..70f6774
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# Hooks plugin
+
+Gerrit does not support the [standard server-side git hooks][1] in the
+repositories it manages.
+
+This plugin adds support for custom hooks that can be run instead. Refer
+to the [configuration documentation][2] and [list of supported hooks][3]
+for details.
+
+[1]: https://git-scm.com/book/gr/v2/Customizing-Git-Git-Hooks
+[2]: src/main/resources/Documentation/config.md
+[3]: src/main/resources/Documentation/hooks.md
diff --git a/src/main/resources/Documentation/about.md b/src/main/resources/Documentation/about.md
index 17c7998..b8b2e91 100644
--- a/src/main/resources/Documentation/about.md
+++ b/src/main/resources/Documentation/about.md
@@ -1,2 +1,8 @@
-Gerrit does not run any of the standard git hooks in the repositories
-it works with, but this plugin implements its own hook mechanism.
+Gerrit does not support the [standard server-side git hooks][1] in the
+repositories it manages. This plugin adds support for custom hooks that
+can be run instead. Refer to the [configuration documentation][2] and
+[list of supported hooks][3] for details.
+
+[1]: https://git-scm.com/book/gr/v2/Customizing-Git-Git-Hooks
+[2]: config.md
+[3]: hooks.md
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md
index 8e845f9..1023f69 100644
--- a/src/main/resources/Documentation/config.md
+++ b/src/main/resources/Documentation/config.md
@@ -19,11 +19,11 @@
Configuration
-------------
-It is possible to change where this plugin looks for hooks, and what
-filenames it looks for by adding a `[hooks]` section to `gerrit.config`.
+The plugin is configured in a `[hooks]` section in the `gerrit.config` file
+in the site's `etc` folder.
-These configuration values are evaluated at plugin load. If the values are
-changed, the plugin must be reloaded for them to take effect.
+The configuration values are evaluated when the plugin is loaded. If the values
+are changed, the plugin must be reloaded for them to take effect.
A hook may be temporarily disabled by either removing it or renaming it. Its
behavior may be changed by replacing its content. Such changes will take
@@ -87,7 +87,7 @@
If [gerrit.canonicalWebUrl][1] is not set in `gerrit.config` the
`--change-url` flag may not be passed to all hooks. Hooks started out
-of an SSH context (for example the patchset-created hook) don't know
+of an SSH context (for example the `patchset-created` hook) don't know
the server's web URL, unless this variable is configured.
@@ -102,8 +102,8 @@
Gerrit restart) or by setting the log level at runtime with the ssh
command:
----
+```
ssh -p 29418 user@gerrit gerrit logging set-level DEBUG com.googlesource.gerrit.plugins.hooks.HookTask
----
+```
[1]: ../../../Documentation/config-gerrit.html#gerrit.canonicalWebUrl
