zshall manpage

zshall manpage

[Jim]

[-- Attachment #1: Type: text/plain, Size: 1549 bytes --]

Hi devs,

Both zsh.1 and zshall.1 start with the following line:
¨Because zsh contains many features, the zsh manual has been split into
a number of sections¨

Then zsh.1 goes on to list:

zsh                Zsh overview (this section)
zshroadmap   Informal introduction to the manual
...
zshcontrib   Additional zsh functions and utilities
zshall      Meta-man page containing all of the above

Note: list item, zshall states ¨contains all of the above¨.

zshall.1  adds the following line before the list is given:

¨This manual page includes all the separate manual
pages in the following order:¨

Then zshall.1 goes on to repeat the list of man pages,
minus ¨zsh¨ and ¨zshall¨.

Question.  Shouldn´t zshall.1 include ¨zsh¨ in the list of sections?
AFAICT ¨zsh¨ is included in zshall.1.

If you agree that it should the following patch would add it to the
list.

diff --git a/Doc/Zsh/intro.yo b/Doc/Zsh/intro.yo
--- a/Doc/Zsh/intro.yo
+++ b/Doc/Zsh/intro.yo
@@ -15,6 +15,9 @@ startlist()
index a7a2f3248..75d25ce27 100644
 ifzshone(\
 list(em(zsh)         Zsh overview (this section))
 )\
+ifzshall(\
+list(em(zsh)         Zsh overview)
+)\
 list(em(zshroadmap)   Informal introduction to the manual)
 list(em(zshmisc)      Anything not fitting into the other sections)
 list(em(zshexpn)      Zsh command and parameter expansion)

Hope there aren´t any typos in the above patch as I am not currently
on a system I could copy and paste.

Appreciate your time, thanks,

Jim Murphy

Re: zshall manpage

[Peter Stephenson]

On Mon, 2019-05-27 at 06:25 -0500, Jim wrote:
> Hi devs,
> 
> Both zsh.1 and zshall.1 start with the following line:
> ¨Because zsh contains many features, the zsh manual has been split into
> a number of sections¨
> 
> Question.  Shouldn´t zshall.1 include ¨zsh¨ in the list of sections?
> AFAICT ¨zsh¨ is included in zshall.1.
> 
> If you agree that it should the following patch would add it to the
> list.

Seems reasonable --- I've committed this (there was just one trivial
indent issue since it's a bit more literal minded than you might
expect).

Cheers
pws