Making an attempt to clarify a few things in the salt.fileserver.gitfs section

This commit is contained in:
Michael Lustfield 2016-09-28 13:19:59 -07:00
parent c436cba074
commit 41e07a78a1

View File

@ -61703,17 +61703,19 @@ fileserver_backend:
.UNINDENT
.UNINDENT
.sp
As of Salt 2014.7.0, the Git fileserver backend supports \fI\%GitPython\fP, \fI\%pygit2\fP,
and \fI\%dulwich\fP to provide the Python interface to git. If more than one of these
are present, the order of preference for which one will be chosen is the same
as the order in which they were listed: pygit2, GitPython, dulwich (keep in
mind, this order is subject to change).
The Git backend to the fileserver can use a number of different Git providers. As
of 2014.7.0, this includes \fI\%pygit2\fP, \fI\%GitPython\fP, and \fI\%dulwich\fP.
.sp
An optional master config parameter (\fBgitfs_provider\fP) can be used
to specify which provider should be used.
An optional master config parameter (\fBgitfs_provider\fP) can, and should, be used
to specify which provider will be used. If not specified, Salt will attempt to load
the first available module it's able to find.
.sp
More detailed information on how to use gitfs can be found in the Gitfs
Walkthrough\&.
At the time this writing, the current search order is pygit, GitPython, and finally
dulwich. If no provider modules can be loaded, the Git backend will not be available
for use by the fileserver.
.sp
More detailed information on how to use gitfs can be found in the Git Fileserver
Backend Walkthrough\&.
.sp
\fBNOTE:\fP
.INDENT 0.0