mirrors/zsh
1
0
Fork 0
mirror of git://git.code.sf.net/p/zsh/code synced 2025-09-04 10:41:11 +02:00
Code Releases Activity

32528: vcs_info: Document 'post-backend' hook and bzr 'check-for-changes' support.

Browse source
This commit is contained in:
Daniel Shahaf 2014-04-04 13:53:13 +00:00 committed by Frank Terbeck
parent eb4c70d0b7
commit ccc840470a
2 changed files with 17 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
ChangeLog
View file

@ -4,6 +4,9 @@
Functions/VCS_Info/Backends/VCS_INFO_get_data_git, Functions/VCS_Info/Backends/VCS_INFO_get_data_git,
Misc/vcs_info-examples: vcs_info: Add check-for-staged-changes Misc/vcs_info-examples: vcs_info: Add check-for-staged-changes
* 32528: Doc/Zsh/contrib.yo: vcs_info: Document 'post-backend'
hook and bzr 'check-for-changes' support.
2014-03-28 Peter Stephenson <p.w.stephenson@ntlworld.com> 2014-03-28 Peter Stephenson <p.w.stephenson@ntlworld.com>
* Danek Duvall: 32505: Completion/Unix/Command/_pgrep: improved * Danek Duvall: 32505: Completion/Unix/Command/_pgrep: improved

17
Doc/Zsh/contrib.yo
View file

@ -826,13 +826,16 @@ item(tt(check-for-changes))(
If enabled, this style causes the tt(%c) and tt(%u) format escapes to show If enabled, this style causes the tt(%c) and tt(%u) format escapes to show
when the working directory has uncommitted changes. The strings displayed by when the working directory has uncommitted changes. The strings displayed by
these escapes can be controlled via the tt(stagedstr) and tt(unstagedstr) these escapes can be controlled via the tt(stagedstr) and tt(unstagedstr)
styles. The only backends that currently support this option are tt(git) and styles. The only backends that currently support this option are tt(git),
tt(hg) (tt(hg) only supports unstaged). tt(hg), and tt(bzr) (the latter two only support unstaged).
For this style to be evaluated with the tt(hg) backend, the tt(get-revision) For this style to be evaluated with the tt(hg) backend, the tt(get-revision)
style needs to be set and the tt(use-simple) style needs to be unset. The style needs to be set and the tt(use-simple) style needs to be unset. The
latter is the default; the former is not. latter is the default; the former is not.
With tt(bzr) backend, lightweight checkouts only honor this style if
the tt(use-server) style is set.
Note, the actions taken if this style is enabled are potentially expensive Note, the actions taken if this style is enabled are potentially expensive
(read: they may be slow, depending on how big the current repository is). (read: they may be slow, depending on how big the current repository is).
Therefore, it is disabled by default. Therefore, it is disabled by default.
@ -874,7 +877,7 @@ when this style is looked up.
For example, this style can be used to use binaries from non-default For example, this style can be used to use binaries from non-default
installation directories. Assume, tt(git) is installed in /usr/bin but installation directories. Assume, tt(git) is installed in /usr/bin but
your sysadmin installed a newer version in /usr/bin/local. Instead of your sysadmin installed a newer version in /usr/local/bin. Instead of
changing the order of your tt($PATH) parameter, you can do this: changing the order of your tt($PATH) parameter, you can do this:
example(zstyle ':vcs_info:git:*:-all-' command /usr/local/bin/git) example(zstyle ':vcs_info:git:*:-all-' command /usr/local/bin/git)
) )
@ -892,6 +895,9 @@ backend is only usable if you have set the environment variable
tt(P4CONFIG) to a file name and have corresponding files in the root tt(P4CONFIG) to a file name and have corresponding files in the root
directories of each Perforce client. See comments in the function directories of each Perforce client. See comments in the function
tt(VCS_INFO_detect_p4) for more detail. tt(VCS_INFO_detect_p4) for more detail.
The Bazaar backend (tt(bzr)) uses this to permit contacting the server
about lightweight checkouts, see the tt(check-for-changes) style.
) )
kindex(use-simple) kindex(use-simple)
item(tt(use-simple))( item(tt(use-simple))(
@ -1333,6 +1339,11 @@ This hooks is called when no version control system was detected.
The `hook_com' parameter is not used. The `hook_com' parameter is not used.
) )
item(tt(post-backend))(
Called as soon as the backend has finished collecting information.
The `tt(hook_com)' keys available are as for the tt(set-message) hook.
)
item(tt(post-quilt))( item(tt(post-quilt))(
Called after the tt(quilt) support is done. The following information Called after the tt(quilt) support is done. The following information
is passed as arguments to the hook: 1. the quilt-support mode (`addon' or is passed as arguments to the hook: 1. the quilt-support mode (`addon' or