diff options
| author | Daniel Shahaf <d.s@daniel.shahaf.name> | 2017-12-30 06:14:09 +0000 |
|---|---|---|
| committer | Daniel Shahaf <d.s@daniel.shahaf.name> | 2017-12-30 06:14:22 +0000 |
| commit | a8ad9768bdf68562c929d6558ef74fb727645f55 (patch) | |
| tree | 385480f5652e72289866d0aa29ee7d30ea2d5b77 /Functions/VCS_Info/VCS_INFO_formats | |
| parent | d303dfa7f59aef999c43e2a7a56aac7099e40454 (diff) | |
| download | zsh-a8ad9768bdf68562c929d6558ef74fb727645f55.tar.gz zsh-a8ad9768bdf68562c929d6558ef74fb727645f55.tar.xz zsh-a8ad9768bdf68562c929d6558ef74fb727645f55.zip | |
unposted: vcs_info: Add docstrings to the internal functions VCS_INFO_formats and VCS_INFO_set.
Diffstat (limited to 'Functions/VCS_Info/VCS_INFO_formats')
| -rw-r--r-- | Functions/VCS_Info/VCS_INFO_formats | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/Functions/VCS_Info/VCS_INFO_formats b/Functions/VCS_Info/VCS_INFO_formats index 4d0dd75c2..e0e1dc738 100644 --- a/Functions/VCS_Info/VCS_INFO_formats +++ b/Functions/VCS_Info/VCS_INFO_formats @@ -34,7 +34,7 @@ hook_com[subdir_orig]="${hook_com[subdir]}" VCS_INFO_hook 'post-backend' -## description: +## description (for backend authors): # action: a string that signals a certain non-default condition in the # repository (like 'rebase-i' in git). If this in non-empty, # the actionformats will be used, too. @@ -49,6 +49,11 @@ VCS_INFO_hook 'post-backend' # should be provided. eg: # VCS_INFO_formats '' "${foobranch}" "${foobase}" '' '' '' "${foomisc}" +## description (vcs_info internals): +# This function is called by the backend with information about the repository, +# and (after some manipulations) populates the ${msgs} variable in preparation +# for calling VCS_INFO_set. + if [[ -n ${hook_com[action]} ]] ; then zstyle -a ":vcs_info:${vcs}:${usercontext}:${rrn}" actionformats msgs (( ${#msgs} < 1 )) && msgs[1]=' (%s)-[%b|%a]%u%c-' |