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

34381: vcs_info: Documentation update

Browse source 
This adds documentation for more hooks and styles available in
vcs_info:

  - patch-format
  - nopatch-format
  - get-unapplied
  - pre-addon-quilt
  - set-patch-format
This commit is contained in:
Daniel Shahaf 2015-01-25 15:20:49 +01:00 committed by Frank Terbeck
parent 04aafe61c4
commit 5a1fdc0f1c
2 changed files with 65 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
ChangeLog
View file

@ -1,3 +1,7 @@
2015-01-25 Daniel Shahaf <d.s@daniel.shahaf.name>
* 34381: Doc/Zsh/contrib.yo: vcs_info: Documentation update
2015-01-25 Frank Terbeck <ft@bewatermyfriend.org> 2015-01-25 Frank Terbeck <ft@bewatermyfriend.org>
* unposted: ChangeLog: Forgot X-Seq: numbers with Daniel's last * unposted: ChangeLog: Forgot X-Seq: numbers with Daniel's last

65
Doc/Zsh/contrib.yo
View file

@ -948,6 +948,21 @@ item(tt(hooks))(
A list style that defines hook-function names. See bf(Hooks in vcs_info) A list style that defines hook-function names. See bf(Hooks in vcs_info)
below for details. below for details.
) )
kindex(patch-format)
kindex(nopatch-format)
xitem(tt(patch-format))
item(tt(nopatch-format))(
This pair of styles format the patch information used by the tt(%m) expando in
formats and actionformats for the tt(git) and tt(hg) backends. The value is
subject to certain tt(%)-expansions described below.
)
kindex(get-unapplied)
item(tt(get-unapplied))(
This boolean style controls whether a backend should attempt to gather a list
of unapplied patches (for example with Mercurial Queue patches).
Used by the tt(quilt) and tt(hg) backends.
)
enditem() enditem()
The default values for these styles in all contexts are: The default values for these styles in all contexts are:
@ -979,6 +994,9 @@ sitem(tt(use-quilt))(false)
sitem(tt(quilt-standalone))(false) sitem(tt(quilt-standalone))(false)
sitem(tt(quilt-patch-dir))(empty - use tt($QUILT_PATCHES)) sitem(tt(quilt-patch-dir))(empty - use tt($QUILT_PATCHES))
sitem(tt(quiltcommand))(quilt) sitem(tt(quiltcommand))(quilt)
sitem(tt(patch-format))(var(backend dependent))
sitem(tt(nopatch-format))(var(backend dependent))
sitem(tt(get-unapplied))(false)
endsitem() endsitem()
In normal tt(formats) and tt(actionformats) the following replacements are In normal tt(formats) and tt(actionformats) the following replacements are
@ -1000,11 +1018,26 @@ sitem(tt(%r))(The repository name. If tt(%R) is tt(/foo/bar/repoXY), tt(%r)
is tt(repoXY).) is tt(repoXY).)
sitem(tt(%S))(A subdirectory within a repository. If tt($PWD) is sitem(tt(%S))(A subdirectory within a repository. If tt($PWD) is
tt(/foo/bar/repoXY/beer/tasty), tt(%S) is tt(beer/tasty).) tt(/foo/bar/repoXY/beer/tasty), tt(%S) is tt(beer/tasty).)
sitem(tt(%m))(A "misc" replacement. It is at the discretion of the backend to
decide what this replacement expands to. It is currently used by the tt(hg)
and tt(git) backends to display patch information from the tt(mq) and
tt(stgit) extensions.)
endsitem() endsitem()
startitem()
item(tt(%m))(
A "misc" replacement. It is at the discretion of the backend to
decide what this replacement expands to.
The tt(hg) and tt(git) backends use this expando to display patch information.
tt(hg) sources patch information from the tt(mq) extensions; tt(git) from the
tt(rebase) command and from the and tt(stgit) extension. The tt(patch-format)
and tt(nopatch-format) styles control the generated string. The former is used
when at least one patch from the patch queue has been applied, and the latter
otherwise.
The tt(hg) backend displays bookmark information in this expando (in addition
to tt(mq) information). See the tt(get-mq) and tt(get-bookmarks) styles. Both
of these styles may be enabled at the same time. If both are enabled, both
resulting strings will be shown separated by a semicolon (that cannot currently
be customized).
)
enditem()
In tt(branchformat) these replacements are done: In tt(branchformat) these replacements are done:
@ -1384,6 +1417,30 @@ If tt(ret) is set to non-zero, the string in
tt(${hook_com[rev-replace]}) will be used unchanged as the tt(${hook_com[rev-replace]}) will be used unchanged as the
`tt(%i)' replacement in the variables set by tt(vcs_info). `tt(%i)' replacement in the variables set by tt(vcs_info).
) )
item(tt(pre-addon-quilt))(
This hook is used when tt(vcs_info)'s quilt functionality is active in "addon"
mode (quilt used on top of a real version control system). It is activated
right before any quilt specific action is taken.
Setting the `tt(ret)' variable in this hook to a non-zero value avoids the
quilt specific to be run at all.
)
item(tt(set-patch-format))(
This hook is used to control some of the possible expansions in
tt(patch-format) and tt(nopatch-format) styles with patch queue systems such as
quilt, mqueue and the like.
This hook is used in the tt(git), tt(hg) and tt(quilt) backends.
The hook allows the control of the tt(%p) (tt(${hook_com[applied]})) and tt(%u)
(tt(${hook_com[unapplied]})) expansion in all backends that use the hook. With
the mercurial backend, the tt(%g) (tt(${hook_com[guards]})) expansion is
controllable in addition to that.
If tt(ret) is set to non-zero, the string in tt(${hook_com[patch-replace]})
will be used unchanged instead of an expanded format from tt(patch-format) or
tt(nopatch-format).
)
item(tt(set-message))( item(tt(set-message))(
Called each time before a `tt(vcs_info_msg_N_)' message is set. Called each time before a `tt(vcs_info_msg_N_)' message is set.
It takes two arguments; the first being the `N' in the message It takes two arguments; the first being the `N' in the message