From: Jonathan Nieder <jrnieder@gmail.com>
To: git@vger.kernel.org
Cc: "Stephen Boyd" <bebarino@gmail.com>,
"Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>,
"Pierre Habouzit" <madcoder@debian.org>
Subject: [PATCH 02/10] parse-options: clearer reporting of API misuse
Date: Wed, 1 Dec 2010 17:29:23 -0600 [thread overview]
Message-ID: <20101201232923.GC31815@burratino> (raw)
In-Reply-To: <20101201232728.GA31815@burratino>
The PARSE_OPT_LASTARG_DEFAULT flag is meant for options like
--contains that (1) traditionally had a mandatory argument and
(2) have some better behavior to use when appearing in the final
position. It makes no sense to combine this with OPTARG, so ever
since v1.6.4-rc0~71 (parse-options: add parse_options_check to
validate option specs, 2009-07-09) this mistake is flagged with
error: `--option` uses incompatible flags LASTARG_DEFAULT and OPTARG
and an exit status representing an error in commandline usage.
Unfortunately that which might confuse scripters calling such an
erroneous program into thinking the _script_ contains an error.
Clarify that it is an internal error by dying with a message beginning
"fatal: BUG: ..." and status 128.
While at it, clean up parse_options_check to prepare for more checks.
Long term, it would be nicer to make such checks happen at compile
time.
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
parse-options.c | 25 ++++++++++---------------
1 files changed, 10 insertions(+), 15 deletions(-)
diff --git a/parse-options.c b/parse-options.c
index 196ba71..12f100b 100644
--- a/parse-options.c
+++ b/parse-options.c
@@ -11,6 +11,13 @@ static int parse_options_usage(struct parse_opt_ctx_t *ctx,
#define OPT_SHORT 1
#define OPT_UNSET 2
+static NORETURN void optbug(const struct option *opt, const char *reason)
+{
+ if (opt->long_name)
+ die("BUG: option '%s' %s", opt->long_name, reason);
+ die("BUG: switch '%c' %s", opt->short_name, reason);
+}
+
static int opterror(const struct option *opt, const char *reason, int flags)
{
if (flags & OPT_SHORT)
@@ -316,24 +323,12 @@ static void check_typos(const char *arg, const struct option *options)
static void parse_options_check(const struct option *opts)
{
- int err = 0;
-
for (; opts->type != OPTION_END; opts++) {
if ((opts->flags & PARSE_OPT_LASTARG_DEFAULT) &&
- (opts->flags & PARSE_OPT_OPTARG)) {
- if (opts->long_name) {
- error("`--%s` uses incompatible flags "
- "LASTARG_DEFAULT and OPTARG", opts->long_name);
- } else {
- error("`-%c` uses incompatible flags "
- "LASTARG_DEFAULT and OPTARG", opts->short_name);
- }
- err |= 1;
- }
+ (opts->flags & PARSE_OPT_OPTARG))
+ optbug(opts, "uses incompatible flags "
+ "LASTARG_DEFAULT and OPTARG");
}
-
- if (err)
- exit(129);
}
void parse_options_start(struct parse_opt_ctx_t *ctx,
--
1.7.2.3
next prev parent reply other threads:[~2010-12-01 23:29 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-12-01 23:27 [PATCH v3 00/10] update-index: migrate to parse-options API Jonathan Nieder
2010-12-01 23:28 ` [PATCH 01/10] parse-options: Don't call parse_options_check() so much Jonathan Nieder
2010-12-05 18:14 ` René Scharfe
2010-12-06 7:57 ` Stephen Boyd
2010-12-01 23:29 ` Jonathan Nieder [this message]
2010-12-02 4:57 ` [PATCH 02/10] parse-options: clearer reporting of API misuse Jonathan Nieder
2010-12-02 6:01 ` [PATCH 02/10 v2] " Jonathan Nieder
2010-12-02 6:13 ` [PATCH 02/10 v2 resend] " Jonathan Nieder
2010-12-01 23:29 ` [PATCH 03/10] parse-options: move NODASH sanity checks to parse_options_check Jonathan Nieder
2010-12-02 6:05 ` [PATCH 03/10 v2] " Jonathan Nieder
2010-12-01 23:30 ` [PATCH 04/10] parse-options: sanity check PARSE_OPT_NOARG flag Jonathan Nieder
2010-12-02 6:08 ` [PATCH 04/10 v2] " Jonathan Nieder
2010-12-01 23:30 ` [PATCH 05/10] parse-options: do not infer PARSE_OPT_NOARG from option type Jonathan Nieder
2010-12-01 23:31 ` [PATCH 06/10] parse-options: never suppress arghelp if LITERAL_ARGHELP is set Jonathan Nieder
2010-12-03 9:16 ` Stephen Boyd
2010-12-03 9:40 ` Jonathan Nieder
2010-12-03 17:53 ` Stephen Boyd
2010-12-01 23:32 ` [PATCH 07/10] parse-options: allow git commands to invent new option types Jonathan Nieder
2010-12-01 23:32 ` [PATCH 08/10] parse-options: make resuming easier after PARSE_OPT_STOP_AT_NON_OPTION Jonathan Nieder
2010-12-01 23:33 ` [PATCH 09/10] setup: save prefix (original cwd relative to toplevel) in startup_info Jonathan Nieder
2010-12-01 23:34 ` [PATCH 10/10] update-index: migrate to parse-options API Jonathan Nieder
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=20101201232923.GC31815@burratino \
--to=jrnieder@gmail.com \
--cc=bebarino@gmail.com \
--cc=git@vger.kernel.org \
--cc=madcoder@debian.org \
--cc=pclouds@gmail.com \
/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).