zuul/zuul
Code Issues Proposed changes

Clarify canonical_hostname documentation

Browse Source 
Change-Id: I91fdba8cde3f2ae0eedb77164acd49d75acd4786
This commit is contained in:
James E. Blair
2017-06-29 11:09:18 -07:00
parent 5f11ff3629
commit cc3ca7dc61
2 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/admin/drivers/gerrit.rst
View File

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

12
doc/source/admin/drivers/github.rst
View File

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