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

36078: vcs_info: Adjust documentation for no longer exporting

Browse source
This commit is contained in:
Mikael Magnusson 2015-08-10 18:05:05 +02:00
parent c5abf2bcff
commit 46a46a90c2
2 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
ChangeLog
View file

@ -13,6 +13,9 @@
Functions/VCS_Info/vcs_info_printsys: vcs_info: stop exporting
everything
* 36078: Doc/Zsh/contrib.yo: vcs_info: Adjust documentation for
no longer exporting
2015-08-11 Barton E. Schaefer <schaefer@zsh.org>
* 36108: NEWS: list of major changes so far since 5.0.8

11
Doc/Zsh/contrib.yo
View file

@ -756,7 +756,7 @@ revision number. This style lets you modify how that string should look.
)
kindex(nvcsformats)
item(tt(nvcsformats))(
These "formats" are exported when we didn't detect a version control system
These "formats" are set when we didn't detect a version control system
for the current directory or tt(vcs_info) was disabled. This is useful if
you want tt(vcs_info) to completely take over the generation of your
prompt. You would do something like tt(PS1='${vcs_info_msg_0_}') to
@ -775,7 +775,7 @@ behavior using hooks.
kindex(max-exports)
item(tt(max-exports))(
Defines the maximum number of
tt(vcs_info_msg_*_) variables tt(vcs_info) will export.
tt(vcs_info_msg_*_) variables tt(vcs_info) will set.
)
kindex(enable)
item(tt(enable))(
@ -1224,16 +1224,15 @@ All functions named tt(VCS_INFO_*) are for internal use only.
subsect(Variable Description)
startitem()
item(tt(${vcs_info_msg_)var(N)tt(_)}) (Note the trailing underscore))
(
item(tt(${vcs_info_msg_)var(N)tt(_}) (Note the trailing underscore))(
Where var(N) is an integer, e.g., tt(vcs_info_msg_0_). These variables
are the storage for the informational message the last tt(vcs_info) call
has assembled. These are strongly connected to the tt(formats),
tt(actionformats) and tt(nvcsformats) styles described above. Those styles
are lists. The first member of that list gets expanded into
tt(${vcs_info_msg_0_}), the second into tt(${vcs_info_msg_1_})
and the Nth into tt(${vcs_info_msg_N-1_}). These parameters are
exported into the environment. (See the tt(max-exports) style above.)
and the Nth into tt(${vcs_info_msg_N-1_}). (See the tt(max-exports)
style above.)
)
enditem()