public inbox for gentoo-pms@lists.gentoo.org
 help / color / mirror / Atom feed
From: "Michał Górny" <mgorny@gentoo.org>
To: gentoo-pms@lists.gentoo.org
Cc: "Michał Górny" <mgorny@gentoo.org>
Subject: [gentoo-pms] [PATCH 5/6] *into, *opts: Clarify the number of arguments
Date: Tue,  1 May 2018 13:24:00 +0200	[thread overview]
Message-ID: <20180501112401.7606-6-mgorny@gentoo.org> (raw)
In-Reply-To: <20180501112401.7606-1-mgorny@gentoo.org>

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.
---
 pkg-mgr-commands.tex | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex
index 6bb06ca..ad64ad1 100644
--- a/pkg-mgr-commands.tex
+++ b/pkg-mgr-commands.tex
@@ -715,8 +715,9 @@ 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\}}
+\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
@@ -728,7 +729,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.
 
-- 
2.17.0



  parent reply	other threads:[~2018-05-01 11:24 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-01 11:23 [gentoo-pms] [PATCH 0/6] Ebuild-specific commands clarification & cleanup Michał Górny
2018-05-01 11:23 ` [gentoo-pms] [PATCH 1/6] nonfatal: Reword argument handling to be cleaner Michał Górny
2018-05-01 11:23 ` [gentoo-pms] [PATCH 2/6] best_version: Explicitly specify the output format Michał Górny
2018-05-01 11:33   ` Ulrich Mueller
2018-05-01 11:49     ` Michał Górny
2018-05-01 11:49     ` Ulrich Mueller
2018-05-01 11:23 ` [gentoo-pms] [PATCH 3/6] Account for 'Build commands' being run in src_test Michał Górny
2018-05-01 11:23 ` [gentoo-pms] [PATCH 4/6] *into, *opts: Reword to use 'as ...' wording from 'do*' Michał Górny
2018-05-01 11:24 ` Michał Górny [this message]
2018-05-01 11:35   ` [gentoo-pms] [PATCH 5/6] *into, *opts: Clarify the number of arguments Ulrich Mueller
2018-05-01 11:24 ` [gentoo-pms] [PATCH 6/6] *into, *opts: Remove redundant offset-prefix sentence from heading Michał Górny

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180501112401.7606-6-mgorny@gentoo.org \
    --to=mgorny@gentoo.org \
    --cc=gentoo-pms@lists.gentoo.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox