From cc3ca7dc618f4130fe7e089c861b231bef28894e Mon Sep 17 00:00:00 2001 From: "James E. Blair" Date: Thu, 29 Jun 2017 11:09:18 -0700 Subject: [PATCH] Clarify canonical_hostname documentation Change-Id: I91fdba8cde3f2ae0eedb77164acd49d75acd4786 --- doc/source/admin/drivers/gerrit.rst | 12 ++++++------ doc/source/admin/drivers/github.rst | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/source/admin/drivers/gerrit.rst b/doc/source/admin/drivers/gerrit.rst index 470b4e89ac..29e136be64 100644 --- a/doc/source/admin/drivers/gerrit.rst +++ b/doc/source/admin/drivers/gerrit.rst @@ -35,12 +35,12 @@ The supported options in zuul.conf connections are: **canonical_hostname** 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. 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. + identify projects from this connection by name and in preparing + repos on the filesystem for use by jobs. Note that Zuul will still + only communicate with the Gerrit server identified by **server**; + this option is useful if users customarily use a different hostname + to clone or pull git repos so that when Zuul places them in the + job's working directory, they appear under this directory name. ``canonical_hostname=git.example.com`` **port** diff --git a/doc/source/admin/drivers/github.rst b/doc/source/admin/drivers/github.rst index 9f116ee52a..9740292415 100644 --- a/doc/source/admin/drivers/github.rst +++ b/doc/source/admin/drivers/github.rst @@ -49,12 +49,12 @@ The supported options in zuul.conf connections are: **canonical_hostname** The canonical hostname associated with the git repos on the GitHub 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. 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. + identify projects from this connection by name and in preparing + repos on the filesystem for use by jobs. Note that Zuul will still + only communicate with the GitHub server identified by **server**; + this option is useful if users customarily use a different hostname + to clone or pull git repos so that when Zuul places them in the + job's working directory, they appear under this directory name. ``canonical_hostname=git.example.com`` Trigger Configuration