system/zsh
system/zsh
1
0
Fork 0
mirror of https://github.com/zsh-users/zsh synced 2024-09-06 00:14:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

45112: zshmodules: Explicitly document the return values of the 'zstyle' getters -s, -b, and -a.

Browse source
This commit is contained in:
Daniel Shahaf 2019-12-21 15:58:28 +00:00
parent 6e5bba8cba
commit 105ca83aa2
2 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
ChangeLog
View file

@ -1,5 +1,8 @@
2019-12-22 Daniel Shahaf <danielsh@apache.org>
* 45112: Doc/Zsh/mod_zutil.yo: zshmodules: Explicitly document
the return values of the 'zstyle' getters -s, -b, and -a.
* 45113: Doc/Zsh/contrib.yo: vcs_info docs: Clarify documentation
of the %p/%u/%a patch-format expandos.

6
Doc/Zsh/mod_zutil.yo
View file

@ -81,17 +81,23 @@ item(tt(zstyle -s) var(context) var(style) var(name) [ var(sep) ])(
The parameter var(name) is set to the value of the style interpreted as a
string. If the value contains several strings they are concatenated with
spaces (or with the var(sep) string if that is given) between them.
Return tt(0) if the style is set, tt(1) otherwise.
)
item(tt(zstyle -b) var(context) var(style) var(name))(
The value is stored in var(name) as a boolean, i.e. as the string
`tt(yes)' if the value has only one string and that string is equal to one
of `tt(yes)', `tt(true)', `tt(on)', or `tt(1)'. If the value is any other
string or has more than one string, the parameter is set to `tt(no)'.
Return tt(0) if var(name) is set to `tt(yes)', tt(1) otherwise.
)
item(tt(zstyle -a) var(context) var(style) var(name))(
The value is stored in var(name) as an array. If var(name) is declared
as an associative array, the first, third, etc. strings are used as the
keys and the other strings are used as the values.
Return tt(0) if the style is set, tt(1) otherwise.
)
xitem(tt(zstyle -t) var(context) var(style) [ var(string) ... ])
item(tt(zstyle -T) var(context) var(style) [ var(string) ... ])(