Gentoo Archives: gentoo-pms

From: "Michał Górny" <mgorny@g.o>
To: gentoo-pms@l.g.o
Cc: "Michał Górny" <mgorny@g.o>
Subject: [gentoo-pms] [PATCH v2 5/6] *into, *opts: Clarify the number of arguments
Date: Tue, 01 May 2018 17:01:56
Message-Id: 20180501165922.22032-5-mgorny@gentoo.org
In Reply to: [gentoo-pms] [PATCH v2 1/6] nonfatal: Reword argument handling to be cleaner by "Michał Górny"
1 Clarify the number of arguments taken by *into and *opts. The former
2 always takes a single argument, so clarify that calling it without
3 arguments is invalid. The latter may take 0+ arguments (with 0
4 resetting the list), so clarify that the correct way is to pass multiple
5 arguments rather than a single quoted argument.
6 ---
7 pkg-mgr-commands.tex | 15 ++++++++-------
8 1 file changed, 8 insertions(+), 7 deletions(-)
9
10 diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex
11 index 058be89..6397a4b 100644
12 --- a/pkg-mgr-commands.tex
13 +++ b/pkg-mgr-commands.tex
14 @@ -714,12 +714,11 @@ has returned.
15
16 \begin{description}
17
18 -\item[into] Sets the value of \t{DESTTREE} for future invocations
19 - of the above utilities. Creates the directory under \t{\$\{ED\}}
20 - in offset-prefix aware EAPIs or under \t{\$\{D\}} in offset-prefix
21 - agnostic EAPIs, using \t{install -d} with no additional options,
22 - if it does not already exist. Failure behaviour is EAPI dependent
23 - as per section~\ref{sec:failure-behaviour}.
24 +\item[into] Takes exactly one argument, and sets the value of \t{DESTTREE} for future invocations of
25 + the above utilities to it. Creates the directory under \t{\$\{ED\}} in offset-prefix aware
26 + EAPIs or under \t{\$\{D\}} in offset-prefix agnostic EAPIs, using \t{install -d} with no
27 + additional options, if it does not already exist. Failure behaviour is EAPI dependent as per
28 + section~\ref{sec:failure-behaviour}.
29
30 \item[insinto] As \t{into}, for \t{INSDESTTREE}.
31
32 @@ -727,7 +726,9 @@ has returned.
33
34 \item[docinto] As \t{into}, for install subdirectory of \t{dodoc} et al.
35
36 -\item[insopts] Sets the options passed by \t{doins} et al.\ to the \t{install} command.
37 +\item[insopts] Takes zero or more arguments, and sets the options passed by \t{doins} et al.
38 + to the \t{install} command to them. When called with no arguments, resets the option list
39 + to empty.
40
41 \item[diropts] As \t{insopts}, for \t{dodir} et al.
42
43 --
44 2.17.0

Replies