Documentation bug - section "Prompt Expansion"

Documentation bug - section "Prompt Expansion"

[Amos Shapira]

Hello,

Looking through the manuals for the special treatment for prompt
variables, there are multiple references to section "Prompt Expansion"
(e.g. under "HISTORY EXPANSION":
(see Prompt Expansion in zshmisc(1))

But I couldn't find such a section, instead I found a section named
"EXPANSION OF PROMPT SEQUENCES"

This causes lost time searching for the wrong term.

Cheers,

--Amos
(I'm not subscribed to the list so please CC me).

Re: Documentation bug - section "Prompt Expansion"

[Peter Stephenson]

On Fri, 6 Feb 2009 11:42:01 +1100
Amos Shapira <amos.shapira@gmail.com> wrote:
> Looking through the manuals for the special treatment for prompt
> variables, there are multiple references to section "Prompt Expansion"
> (e.g. under "HISTORY EXPANSION":
> (see Prompt Expansion in zshmisc(1))
> 
> But I couldn't find such a section, instead I found a section named
> "EXPANSION OF PROMPT SEQUENCES"

You're right, this is screwy.  The problem is that the Texinfo format has
both a chapter and a node called Prompt Expansion, but it's been
(annoyingly) named differently in the Unix manual.  However, it's probably
best to leave the section name and correct the references to it.

Index: Doc/Zsh/builtins.yo
===================================================================
RCS file: /cvsroot/zsh/zsh/Doc/Zsh/builtins.yo,v
retrieving revision 1.115
diff -u -r1.115 builtins.yo
--- Doc/Zsh/builtins.yo	25 Jan 2009 18:19:29 -0000	1.115
+++ Doc/Zsh/builtins.yo	6 Feb 2009 09:48:13 -0000
@@ -897,7 +897,7 @@
 )
 item(tt(-P))(
 Perform prompt expansion (see
-ifzman(zmanref(zshmisc))\
+ifzman(EXPANSION OF PROMPT SEQUENCES IN zmanref(zshmisc))\
 ifnzman(noderef(Prompt Expansion))\
 ).
 )
Index: Doc/Zsh/compsys.yo
===================================================================
RCS file: /cvsroot/zsh/zsh/Doc/Zsh/compsys.yo,v
retrieving revision 1.218
diff -u -r1.218 compsys.yo
--- Doc/Zsh/compsys.yo	2 Nov 2008 14:12:30 -0000	1.218
+++ Doc/Zsh/compsys.yo	6 Feb 2009 09:48:13 -0000
@@ -1545,7 +1545,8 @@
 what these matches are.  This string may also contain the following
 sequences to specify output attributes,
 ifnzman(noderef(Prompt Expansion))\
-ifzman(as described in the section PROMPT EXPANSION in zmanref(zshmisc)):
+ifzman(as described in the section EXPANSION OF PROMPT SEQUENCES in
+zmanref(zshmisc)):
 `tt(%B)', `tt(%S)', `tt(%U)', `tt(%F)', `tt(%K)' and their lower case
 counterparts, as well as `tt(%{)...tt(%})'.  `tt(%F)', `tt(%K)' and
 `tt(%{)...tt(%})' take arguments in the same form as prompt
Index: Doc/Zsh/contrib.yo
===================================================================
RCS file: /cvsroot/zsh/zsh/Doc/Zsh/contrib.yo,v
retrieving revision 1.95
diff -u -r1.95 contrib.yo
--- Doc/Zsh/contrib.yo	3 Jan 2009 18:40:17 -0000	1.95
+++ Doc/Zsh/contrib.yo	6 Feb 2009 09:48:13 -0000
@@ -2770,7 +2770,7 @@
 `tt(:nslookup)' to set the prompt and the right-side prompt, respectively.
 The usual expansions for the tt(PS1) and tt(RPS1) parameters may be used
 (see
-ifzman(zmanref(zshmisc))\
+ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
 ifnzman(noderef(Prompt Expansion))\
 ).
 )
Index: Doc/Zsh/expn.yo
===================================================================
RCS file: /cvsroot/zsh/zsh/Doc/Zsh/expn.yo,v
retrieving revision 1.101
diff -u -r1.101 expn.yo
--- Doc/Zsh/expn.yo	27 Jan 2009 09:55:33 -0000	1.101
+++ Doc/Zsh/expn.yo	6 Feb 2009 09:48:13 -0000
@@ -64,7 +64,7 @@
 the history list is called a history em(event) and is assigned a number,
 beginning with 1 (one) when the shell starts up.  The history number that
 you may see in your prompt (see
-ifzman(Prompt Expansion in zmanref(zshmisc))\
+ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
 ifnzman(noderef(Prompt Expansion))\
 ) is the number that is to be assigned to the em(next) command.
 
@@ -708,7 +708,9 @@
 )
 item(tt(%))(
 Expand all tt(%) escapes in the resulting words in the same way as in
-prompts (see noderef(Prompt Expansion)). If this flag is given twice,
+prompts (see 
+ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
+ifnzman(noderef(Prompt Expansion))). If this flag is given twice,
 full prompt expansion is done on the resulting words, depending on the
 setting of the tt(PROMPT_PERCENT), tt(PROMPT_SUBST) and tt(PROMPT_BANG)
 options.
Index: Doc/Zsh/options.yo
===================================================================
RCS file: /cvsroot/zsh/zsh/Doc/Zsh/options.yo,v
retrieving revision 1.70
diff -u -r1.70 options.yo
--- Doc/Zsh/options.yo	1 Feb 2009 08:52:47 -0000	1.70
+++ Doc/Zsh/options.yo	6 Feb 2009 09:48:13 -0000
@@ -977,7 +977,9 @@
 cindex(prompt, ! expansion)
 item(tt(PROMPT_BANG) <K>)(
 If set, `tt(!)' is treated specially in prompt expansion.
-See noderef(Prompt Expansion).
+See
+ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
+ifnzman(noderef(Prompt Expansion)).
 )
 pindex(PROMPT_CR)
 cindex(prompt, with CR)
@@ -1006,7 +1008,9 @@
 cindex(prompt, % expansion)
 item(tt(PROMPT_PERCENT) <C> <Z>)(
 If set, `tt(%)' is treated specially in prompt expansion.
-See noderef(Prompt Expansion).
+See
+ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
+ifnzman(noderef(Prompt Expansion)).
 )
 pindex(PROMPT_SUBST)
 cindex(prompt, parameter expansion)
Index: Doc/Zsh/params.yo
===================================================================
RCS file: /cvsroot/zsh/zsh/Doc/Zsh/params.yo,v
retrieving revision 1.50
diff -u -r1.50 params.yo
--- Doc/Zsh/params.yo	9 Jan 2009 20:28:30 -0000	1.50
+++ Doc/Zsh/params.yo	6 Feb 2009 09:48:13 -0000
@@ -1031,7 +1031,9 @@
 item(tt(PS1) <S>)(
 The primary prompt string, printed before a command is read.
 the default is `tt(%m%# )'.  It undergoes a special form of expansion
-before being displayed; see noderef(Prompt Expansion).
+before being displayed; see
+ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
+ifnzman(noderef(Prompt Expansion)).
 )

-- 
Peter Stephenson <pws@csr.com>                  Software Engineer
CSR PLC, Churchill House, Cambridge Business Park, Cowley Road
Cambridge, CB4 0WZ, UK                          Tel: +44 (0)1223 692070