From 490478378f5f7bb89d70655c26be79691bb67339 Mon Sep 17 00:00:00 2001 From: Daniel Shahaf Date: Thu, 16 Jan 2020 16:32:37 +0000 Subject: unposted: docs: Fix a cross-reference. --- Doc/Zsh/options.yo | 4 +++- Doc/Zsh/params.yo | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) (limited to 'Doc') diff --git a/Doc/Zsh/options.yo b/Doc/Zsh/options.yo index 88bb643d1..fdea51412 100644 --- a/Doc/Zsh/options.yo +++ b/Doc/Zsh/options.yo @@ -2334,7 +2334,9 @@ cindex(sh, field splitting style) item(tt(SH_WORD_SPLIT) (tt(-y)) )( Causes field splitting to be performed on unquoted parameter expansions. Note that this option has nothing to do with word splitting. -(See noderef(Parameter Expansion).) +(See +ifzman(zmanref(zshexpn))\ +ifnzman(noderef(Parameter Expansion)).) ) pindex(TRAPS_ASYNC) pindex(NO_TRAPS_ASYNC) diff --git a/Doc/Zsh/params.yo b/Doc/Zsh/params.yo index 5025ef477..8daf33d5e 100644 --- a/Doc/Zsh/params.yo +++ b/Doc/Zsh/params.yo @@ -129,7 +129,7 @@ both var(key) and var(value) undergo all forms of expansion allowed for single word shell expansions (this does not include filename generation); these are as performed by the parameter expansion flag tt(LPAR()e+RPAR()) as described in -ifzman(zmanref(zshparam))\ +ifzman(zmanref(zshexpn))\ ifnzman(noderef(Parameter Expansion)). Nested parentheses may surround var(value) and are included as part of the value, which is joined into a plain string; this differs from ksh which -- cgit v1.2.3 From 6f263b5e8972f7858ed389c96211e3828f8ae13a Mon Sep 17 00:00:00 2001 From: Daniel Shahaf Date: Wed, 15 Jan 2020 19:50:54 +0000 Subject: 45306: zstyle docs: Introduce the first synopsis in the same way as all others: with an item()(). --- ChangeLog | 3 +++ Doc/Zsh/mod_zutil.yo | 13 +++++++------ 2 files changed, 10 insertions(+), 6 deletions(-) (limited to 'Doc') diff --git a/ChangeLog b/ChangeLog index 74b14eebb..a5c27f50e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,8 @@ 2020-01-16 Daniel Shahaf + * 45306: Doc/Zsh/mod_zutil.yo: zstyle docs: Introduce the first + synopsis in the same way as all others: with an item()(). + * unposted: Doc/Zsh/options.yo, Doc/Zsh/params.yo: docs: Fix a cross-reference. diff --git a/Doc/Zsh/mod_zutil.yo b/Doc/Zsh/mod_zutil.yo index e556e2b37..5363037ab 100644 --- a/Doc/Zsh/mod_zutil.yo +++ b/Doc/Zsh/mod_zutil.yo @@ -49,7 +49,11 @@ in order to retrieve your preference into the scalar variable tt($REPLY). em(Usage) -The first form (without arguments) lists the definitions. Styles +The forms that operate on patterns are the following. + +startitem() +item(tt(zstyle) [ tt(-L) [ var(pattern) [ var(style) ] ] ])( +Without arguments, lists style definitions. Styles are shown in alphabetic order and patterns are shown in the order tt(zstyle) will test them. @@ -61,10 +65,7 @@ match any supplied pattern beginning `tt(:completion:)', not just tt(":completion:*"): use tt(':completion:\*') to match that. The optional second argument limits the output to a specific var(style) (not a pattern). tt(-L) is not compatible with any other options. - -The other forms are the following: - -startitem() +) item(tt(zstyle) [ tt(-) | tt(-)tt(-) | tt(-e) ] var(pattern) var(style) var(string) ...)( vindex(reply, use of) Defines the given var(style) for the var(pattern) with the var(string)s as @@ -93,7 +94,7 @@ combination is returned. ) enditem() -The other forms can be used to look up or test patterns. +The other forms can be used to look up or test styles for a given context. startitem() item(tt(zstyle -s) var(context) var(style) var(name) [ var(sep) ])( -- cgit v1.2.3 From 0a7bfc0bd27e27829fb00cf4c8149a9fae98bb06 Mon Sep 17 00:00:00 2001 From: Daniel Shahaf Date: Wed, 15 Jan 2020 19:50:55 +0000 Subject: 45307: zstyle docs: Unoverload a placeholder variable name. Use 'pattern' to refer to things matched against contexts and 'metapattern' to refer to things matched against patterns. --- ChangeLog | 3 +++ Doc/Zsh/mod_zutil.yo | 9 +++++---- 2 files changed, 8 insertions(+), 4 deletions(-) (limited to 'Doc') diff --git a/ChangeLog b/ChangeLog index a5c27f50e..7ffdfbcba 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,8 @@ 2020-01-16 Daniel Shahaf + * 45307: Doc/Zsh/mod_zutil.yo: zstyle docs: Unoverload a + placeholder variable name. + * 45306: Doc/Zsh/mod_zutil.yo: zstyle docs: Introduce the first synopsis in the same way as all others: with an item()(). diff --git a/Doc/Zsh/mod_zutil.yo b/Doc/Zsh/mod_zutil.yo index 5363037ab..24aebdfaf 100644 --- a/Doc/Zsh/mod_zutil.yo +++ b/Doc/Zsh/mod_zutil.yo @@ -7,7 +7,7 @@ The tt(zsh/zutil) module only adds some builtins: startitem() findex(zstyle) -xitem(tt(zstyle) [ tt(-L) [ var(pattern) [ var(style) ] ] ]) +xitem(tt(zstyle) [ tt(-L) [ var(metapattern) [ var(style) ] ] ]) xitem(tt(zstyle) [ tt(-e) | tt(-) | tt(-)tt(-) ] var(pattern) var(style) var(string) ...) xitem(tt(zstyle -d) [ var(pattern) [ var(style) ... ] ]) xitem(tt(zstyle -g) var(name) [ var(pattern) [ var(style) ] ]) @@ -52,14 +52,15 @@ em(Usage) The forms that operate on patterns are the following. startitem() -item(tt(zstyle) [ tt(-L) [ var(pattern) [ var(style) ] ] ])( +item(tt(zstyle) [ tt(-L) [ var(metapattern) [ var(style) ] ] ])( Without arguments, lists style definitions. Styles are shown in alphabetic order and patterns are shown in the order tt(zstyle) will test them. If the tt(-L) option is given, listing is done in the form of calls to -tt(zstyle). The optional first argument is a pattern which will be matched -against the string supplied as the pattern for the context; note that +tt(zstyle). The optional first argument, var(metapattern), is a pattern which +will be matched against the string supplied as var(pattern) when the style was +defined. Note: this means, for example, `tt(zstyle -L ":completion:*")' will match any supplied pattern beginning `tt(:completion:)', not just tt(":completion:*"): use tt(':completion:\*') to match that. -- cgit v1.2.3