zsh-workers
 help / color / Atom feed
* [PATCH] Make the expansion of manref()() in ztexi.yo match its expansion in zman.yo.
@ 2020-07-12 18:06 Daniel Shahaf
  0 siblings, 0 replies; only message in thread
From: Daniel Shahaf @ 2020-07-12 18:06 UTC (permalink / raw)
  To: zsh-workers

The difference was mostly harmless in the common case "(see manref(foo)(42))",
which expanded to "(see man page foo(42))" under ztexi.yo, but in other
contexts the ztexi.yo expansion was was nonsensical; for example:

    "the BSD manref(echo)(1) command"

    "the string returned by the manref(getlogin)(3) system call"

    "advisory file locking (via the manref(fcntl)(2) system call)"

    "this is the exact opposite from manref(ls)(1),"

While there, copyedit some uses of manref()().

---
Regarding the mailcap change, the correct reference is mailcap(4) on
FreeBSD and mailcap(5) on Debian.  I didn't check other systems.

Cheers,

Daniel


 Doc/Zsh/builtins.yo | 2 +-
 Doc/Zsh/contrib.yo  | 5 +++--
 Doc/Zsh/jobs.yo     | 2 +-
 Doc/Zsh/params.yo   | 2 +-
 Doc/ztexi.yo        | 2 +-
 5 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/Doc/Zsh/builtins.yo b/Doc/Zsh/builtins.yo
index d35cad182..4b91db1fe 100644
--- a/Doc/Zsh/builtins.yo
+++ b/Doc/Zsh/builtins.yo
@@ -2300,7 +2300,7 @@ findex(umask)
 cindex(umask)
 item(tt(umask) [ tt(-S) ] [ var(mask) ])(
 The umask is set to var(mask).  var(mask) can be either
-an octal number or a symbolic value as described in manref(chmod)(1).
+an octal number or a symbolic value as described in the manref(chmod)(1) man page.
 If var(mask) is omitted, the current value is printed.  The tt(-S)
 option causes the mask to be printed as a symbolic value.  Otherwise,
 the mask is printed as an octal number.  Note that in
diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo
index 7cde0033f..66e6bdc1e 100644
--- a/Doc/Zsh/contrib.yo
+++ b/Doc/Zsh/contrib.yo
@@ -3560,7 +3560,8 @@ Calling tt(zsh-mime-setup) with the option
 tt(-v) causes verbose output to be shown during the setup operation.
 
 The system respects the tt(mailcap) flags tt(needsterminal) and
-tt(copiousoutput), see manref(mailcap)(4).
+tt(copiousoutput); see manref(mailcap)(4) or manref(mailcap)(5)
+(the man page's name varies across platforms).
 
 The functions use the following styles, which are defined with the
 tt(zstyle) builtin command (\
@@ -4465,7 +4466,7 @@ counts the number of arguments passed to each execution of var(command),
 em(including) any var(arg) list.  Also, any time tt(-i) or tt(-I) is used,
 each var(input) is processed separately as if by `tt(-L) tt(1)'.
 
-For details of the other tt(zargs) options, see zmanref(xargs) (but note
+For details of the other tt(zargs) options, see the manref(xargs)(1) man page (but note
 the difference in function between tt(zargs) and tt(xargs)) or run
 tt(zargs) with the tt(-)tt(-help) option.
 )
diff --git a/Doc/Zsh/jobs.yo b/Doc/Zsh/jobs.yo
index 70559f2d8..331b91d8d 100644
--- a/Doc/Zsh/jobs.yo
+++ b/Doc/Zsh/jobs.yo
@@ -111,7 +111,7 @@ cindex(jobs, disowning)
 cindex(disowning jobs)
 findex(disown, use of)
 To avoid having the shell terminate the running jobs, either
-use the bf(nohup) command (see manref(nohup)(1))
+use the manref(nohup)(1) command
 or the tt(disown) builtin.
 sect(Signals)
 The tt(INT) and tt(QUIT) signals for an invoked
diff --git a/Doc/Zsh/params.yo b/Doc/Zsh/params.yo
index 8a6eb2446..36c1ae4c2 100644
--- a/Doc/Zsh/params.yo
+++ b/Doc/Zsh/params.yo
@@ -731,7 +731,7 @@ explicitly set locally.
 )
 vindex(ERRNO)
 item(tt(ERRNO) <S>)(
-The value of errno (see manref(errno)(3))
+The value of tt(errno) (see manref(errno)(3))
 as set by the most recently failed system call.
 This value is system dependent and is intended for debugging
 purposes.  It is also useful with the tt(zsh/system) module which
diff --git a/Doc/ztexi.yo b/Doc/ztexi.yo
index 7d52e6e91..50bae6d48 100644
--- a/Doc/ztexi.yo
+++ b/Doc/ztexi.yo
@@ -150,7 +150,7 @@ def(comment)(1)(\
 
 COMMENT(--- cross-references ---)
 
-def(manref)(2)(man page ARG1+LPAR()ARG2+RPAR())
+def(manref)(2)(ARG1+LPAR()ARG2+RPAR())
 def(zmanref)(1)(manref(ARG1)(1))
 def(noderef)(1)(\
   NOTRANS(@ref{)ARG1+NOTRANS(})\

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, back to index

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-12 18:06 [PATCH] Make the expansion of manref()() in ztexi.yo match its expansion in zman.yo Daniel Shahaf

zsh-workers

Archives are clonable: git clone --mirror http://inbox.vuxu.org/zsh-workers

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://inbox.vuxu.org/vuxu.archive.zsh.workers


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git