Zsh Mailing List Archive
Messages sorted by:
not a PATCH: fix/break indenting in _arguments docs
- X-seq: zsh-workers 29369
- From: Mikael Magnusson <mikachu@xxxxxxxxx>
- To: zsh-workers@xxxxxxx
- Subject: not a PATCH: fix/break indenting in _arguments docs
- Date: Wed, 25 May 2011 00:01:18 +0200
- Dkim-signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:from:to:subject:date:message-id:x-mailer; bh=T21phJFDlI457VCdZeHSa51ywGaxZ9QGs7WSXyeSEHk=; b=woF/LCUdIWLq4AO6BkxpKUbi1rKKUoSbYHZsW34C7nQ1k5jDxkbq3J0dzSuGlRMtT0 W+Gsg2a4FYds51ID0/KbB+OUCS1NR7TYD8AYU7vVO28lLvZ0n9HyGhF4dYCiZ+K2Vw25 LpPOF1Deq/I0Yi+/gmBL4aS8ztdB4Y99RooD4=
- Domainkey-signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=from:to:subject:date:message-id:x-mailer; b=QFkzzRMJZ8XKN4vdkUXzDvk6NyN4YLJIQ5UXJMx/+9OWyokRAJ64Us9aWXR1pZSWse +0+pHM3tq0KHIjelEH0kjfr3suFwiwNSajp2TinPrLlkGrCEYSaCfab496l4oU4eTLTp azAJjdvadOC1e/nIToOb/7+PfCYtmeHAa8Qi4=
- List-help: <mailto:email@example.com>
- List-id: Zsh Workers List <zsh-workers.zsh.org>
- List-post: <mailto:firstname.lastname@example.org>
- Mailing-list: contact zsh-workers-help@xxxxxxx; run by ezmlm
I probably have no idea what I'm doing, but without doing this the
whole rest of the text from the point of the enditem on goes back on the
same column as the tag names in the man pages. Ie, the end of the
_arguments text looks like this:
The last two descriptions say what should be completed as arguments. The
first describes the first argument as a `postscript file' and makes files
ending in `ps' or `eps' be completed. The last description gives all other
arguments the description `page numbers' but does not offer completions.
This function returns status zero if the completions cache correspond-
ing to the given cache identifier needs rebuilding. It determines
The first place it seems to go wrong is here:
refer only to the words after the option. When preceded by
three colons, they are modified to refer only to the words cov-
ered by this description.
Any literal colon in an optname, message, or action must be preceded by a
For some reason the subsequent text gets unindented after an enditem()
instead of staying at the same level. I initially suspected my yodl was
broken, but sshing in to some other hosts it looks like they have the
With the patch however, the indenting is totally wrong in the pdf version,
and it was correct before there.
Other places seem to nest startitem()s without any problem. Maybe I
should look at some yodl docs one of these days.
diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo
index 8ceeb9d..545e616 100644
@@ -3472,7 +3472,6 @@ has not been reached, tt(NORMARG) is set to tt(-1). The caller
should declare `tt(integer NORMARG)' if the tt(-n) option is passed;
otherwise the parameter is not used.
This describes the var(n)'th normal argument. The var(message) will be
@@ -3531,7 +3530,6 @@ utility function like tt(_guard) as part of the action.
The following forms are available for the initial var(optspec), whether
or not the option has arguments.
Here var(optspec) is one of the remaining forms below. This indicates
the following var(optspec) may be repeated. Otherwise if the
@@ -3584,7 +3582,6 @@ value of the style is displayed, with any appearance of the sequence
`tt(%d)' in it replaced by the var(message) of the first var(optarg)
that follows the var(optspec); see below.
It is possible for options with a literal `PLUS()' or `tt(=)' to
appear, but that character must be quoted, for example `tt(-\+)'.
@@ -3592,7 +3589,6 @@ appear, but that character must be quoted, for example `tt(-\+)'.
Each var(optarg) following an var(optspec) must take one of the
An argument to the option; var(message) and var(action) are treated as
@@ -3621,9 +3617,7 @@ modified during the execution or evaluation of the var(action) to refer
only to the words after the option. When preceded by three colons, they
are modified to refer only to the words covered by this description.
Any literal colon in an var(optname), var(message), or var(action)
must be preceded by a backslash, `tt(\:)'.
@@ -3664,7 +3658,6 @@ of tags is needed unless a function call introduces a new one.
The forms for var(action) are as follows.
item(tt( ) (single unquoted space))(
This is useful where an argument is required but it is not possible or
desirable to generate matches for it. The
@@ -3760,7 +3753,6 @@ before executing the var(action) and hence may be referred to inside it,
typically in an expansion of the form `tt($expl[@])' which preserves empty
elements of the array.
During the performance of the action the array `tt(line)'
will be set to the command name and normal arguments from the command
Messages sorted by: