Add some information about canonical_hostname
Change-Id: I84e48ccd8dde5bebbd1decf0ff780e8768270bcd
diff --git a/doc/source/admin/drivers/gerrit.rst b/doc/source/admin/drivers/gerrit.rst
index 6cd2f3d..0efb195 100644
--- a/doc/source/admin/drivers/gerrit.rst
+++ b/doc/source/admin/drivers/gerrit.rst
@@ -36,7 +36,11 @@
The canonical hostname associated with the git repos on the Gerrit
server. Defaults to the value of **server**. This is used to
identify repos from this connection by name and in preparing repos
- on the filesystem for use by jobs.
+ on the filesystem for use by jobs. This only needs to be set in the
+ case where the canonical public location of the git repos is not the
+ same as the Gerrit server and it would be incorrect to refer to
+ those repos in configuration and build scripts using the Gerrit
+ server hostname.
``canonical_hostname=git.example.com``
**port**
diff --git a/doc/source/admin/drivers/github.rst b/doc/source/admin/drivers/github.rst
index cc2a5c9..9aadf7f 100644
--- a/doc/source/admin/drivers/github.rst
+++ b/doc/source/admin/drivers/github.rst
@@ -46,6 +46,17 @@
If not specified, defaults to ``github.com``
``git_host=github.myenterprise.com``
+**canonical_hostname**
+ The canonical hostname associated with the git repos on the GitHub
+ server. Defaults to the value of **git_host**. This is used to
+ identify repos from this connection by name and in preparing repos
+ on the filesystem for use by jobs. This only needs to be set in the
+ case where the canonical public location of the git repos is not the
+ same as the GitHub server and it would be incorrect to refer to
+ those repos in configuration and build scripts using the GitHub
+ server hostname.
+ ``canonical_hostname=git.example.com``
+
Trigger Configuration
---------------------
GitHub webhook events can be configured as triggers.