diff options
| author |   Michał Górny <mgorny@gentoo.org> | 2018-05-01 18:59:21 +0200 |
|---|---|---|
| committer |   Ulrich Müller <ulm@gentoo.org> | 2018-05-04 08:53:51 +0200 |
| commit | 2955b2dfaa5599677bf33e56c7619ccc557ebfff (patch) | |
| tree | f6497ef316fe2a2e7927de43a48bff5da983fe78 | |
| parent | *into, *opts: Reword to use 'as ...' wording from 'do*' (diff) | |
| download | pms-2955b2df.tar.gz pms-2955b2df.tar.bz2 pms-2955b2df.zip | |
*into, *opts: Clarify the number of arguments
Clarify the number of arguments taken by *into and *opts. The former
always takes a single argument, so clarify that calling it without
arguments is invalid. The latter may take 0+ arguments (with 0
resetting the list), so clarify that the correct way is to pass multiple
arguments rather than a single quoted argument.
| -rw-r--r-- | pkg-mgr-commands.tex | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index 058be89..07b8d9f 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -714,12 +714,11 @@ has returned. \begin{description} -\item[into] Sets the value of \t{DESTTREE} for future invocations - of the above utilities. Creates the directory under \t{\$\{ED\}} - in offset-prefix aware EAPIs or under \t{\$\{D\}} in offset-prefix - agnostic EAPIs, using \t{install -d} with no additional options, - if it does not already exist. Failure behaviour is EAPI dependent - as per section~\ref{sec:failure-behaviour}. +\item[into] Takes exactly one argument, and sets the value of \t{DESTTREE} for future invocations + of the above utilities to it. Creates the directory under \t{\$\{ED\}} in offset-prefix aware + EAPIs or under \t{\$\{D\}} in offset-prefix agnostic EAPIs, using \t{install -d} with no + additional options, if it does not already exist. Failure behaviour is EAPI dependent as per + section~\ref{sec:failure-behaviour}. \item[insinto] As \t{into}, for \t{INSDESTTREE}. @@ -727,7 +726,9 @@ has returned. \item[docinto] As \t{into}, for install subdirectory of \t{dodoc} et al. -\item[insopts] Sets the options passed by \t{doins} et al.\ to the \t{install} command. +\item[insopts] Takes zero or more arguments, and sets the options passed by \t{doins} et al.\ + to the \t{install} command to them. When called with no arguments, resets the option list + to empty. \item[diropts] As \t{insopts}, for \t{dodir} et al. |