summary refs log tree commit diff
path: root/Doc
diff options
context:
space:
mode:
authorPeter Stephenson <pws@users.sourceforge.net>2008-09-23 16:10:57 +0000
committerPeter Stephenson <pws@users.sourceforge.net>2008-09-23 16:10:57 +0000
commitf49d738db3d6cacb17cf4374f61948c5634c3aab (patch)
tree1686eed9e461420f6e95cd291192e64f605b8bcd /Doc
parentd3c4108f30fd987724ccffd9559ea2f49ac57328 (diff)
downloadzsh-f49d738db3d6cacb17cf4374f61948c5634c3aab.tar.gz
zsh-f49d738db3d6cacb17cf4374f61948c5634c3aab.tar.xz
zsh-f49d738db3d6cacb17cf4374f61948c5634c3aab.zip
25732: make vcs_info p4 backend use server if style use-server is set
Diffstat (limited to 'Doc')
-rw-r--r--Doc/Zsh/contrib.yo15
1 files changed, 15 insertions, 0 deletions
diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo
index a3a74134e..44b918aac 100644
--- a/Doc/Zsh/contrib.yo
+++ b/Doc/Zsh/contrib.yo
@@ -502,6 +502,21 @@ A list of VCSs, you don't want var(vcs_info) to test for
 repositories (checked in the var(-init-) context, too). Only used if
 tt(enable) contains tt(ALL).
 )
+kindex(use-server)
+item(tt(use-server))(
+This is used by the Perforce backend (tt(p4)) to decide if it should
+contact the Perforce server to find out if a directory is managed
+by Perforce.  This is the only reliable way of doing this, but runs
+the risk of a delay if the server name cannot be found.  If the
+server (more specifically, the var(host)tt(:)var(port) pair describing the
+server) cannot be contacted its name is put into the associative array
+tt(vcs_info_p4_dead_servers) and not contacted again during the session
+until it is removed by hand.  If you do not set this style, the tt(p4)
+backend is only usable if you have set the environment variable
+tt(P4CONFIG) to a file name and have corresponding files in the root
+directories of each Perforce client.  See comments in the function
+tt(VCS_INFO_detect_p4) for more detail.
+)
 kindex(use-simple)
 item(tt(use-simple))(
 If there are two different ways of gathering