dash.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Felix Dietrich <felix.dietrich@sperrhaken.name>
To: dash@vger.kernel.org
Subject: [MAN] Fix description of getopts when last argument reached
Date: Tue, 02 Jun 2015 22:55:19 +0200	[thread overview]
Message-ID: <87r3pt6dag.fsf@sperrhaken.name> (raw)

---
When I read the getopts description in the man-page I got stumped by the
following part:

    getopts optstring var

        [..]

        If there are no remaining arguments, getopts will set var to
        special option, “--”, otherwise, it will set var to “?”

        [..]

After I was unable to get getopts to store "--" in var, I asked for help
on comp.unix.shell [1] where it was pointed out to me that actually the
POSIX description of getopts [2] does not include a special option "--";
dash's behaviour of setting var to "?" after the last argument is
correct and that this is most likely an error in the documention.

In case this is not an error: Under what circumstances will var be set
to "--"?  Could you provide an example?

[1] https://groups.google.com/forum/#!topic/comp.unix.shell/BIR9dDgKZvg
[2] http://pubs.opengroup.org/onlinepubs/9699919799/utilities/getopts.html

 src/dash.1 | 9 ++-------
 1 file changed, 2 insertions(+), 7 deletions(-)

diff --git a/src/dash.1 b/src/dash.1
index 693c970..832eae7 100644
--- a/src/dash.1
+++ b/src/dash.1
@@ -1402,14 +1402,9 @@ By specifying a colon as the first character of
 .Va optstring
 all errors will be ignored.
 .Pp
-A nonzero value is returned when the last option is reached.
-If there are no remaining arguments,
+After the last option
 .Ic getopts
-will set
-.Va var
-to the special option,
-.Dq -- ,
-otherwise, it will set
+will return a non-zero value and set
 .Va var
 to
 .Dq \&? .
-- 
2.1.4


             reply	other threads:[~2015-06-02 20:55 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-06-02 20:55 Felix Dietrich [this message]
2015-06-11  6:34 ` [MAN] Fix description of getopts when last argument reached Herbert Xu

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=87r3pt6dag.fsf@sperrhaken.name \
    --to=felix.dietrich@sperrhaken.name \
    --cc=dash@vger.kernel.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;
as well as URLs for NNTP newsgroup(s).