mirror of
https://github.com/git/git
synced 2024-08-25 02:35:46 +00:00
parseopt: wrap rev-parse --parseopt usage for eval consumption
9c7304e
(print the usage string on stdout instead of stderr,
2010-05-17) broke rev-parse --parseopt: when run with -h, the usage
notice on stdout ended up in the shell eval.
Wrap the usage in a cat <<\EOF ... EOF block when printing to stdout.
I do not expect any usage lines to ever start with EOF so this
shouldn't be an undue burden.
Signed-off-by: Thomas Rast <trast@student.ethz.ch>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
9c7304e3e3
commit
47e9cd28f8
|
@ -408,7 +408,8 @@ static int cmd_parseopt(int argc, const char **argv, const char *prefix)
|
|||
memset(opts + onb, 0, sizeof(opts[onb]));
|
||||
argc = parse_options(argc, argv, prefix, opts, usage,
|
||||
keep_dashdash ? PARSE_OPT_KEEP_DASHDASH : 0 |
|
||||
stop_at_non_option ? PARSE_OPT_STOP_AT_NON_OPTION : 0);
|
||||
stop_at_non_option ? PARSE_OPT_STOP_AT_NON_OPTION : 0 |
|
||||
PARSE_OPT_SHELL_EVAL);
|
||||
|
||||
strbuf_addf(&parsed, " --");
|
||||
sq_quote_argv(&parsed, argv, 0);
|
||||
|
|
|
@ -4,7 +4,8 @@
|
|||
#include "commit.h"
|
||||
#include "color.h"
|
||||
|
||||
static int parse_options_usage(const char * const *usagestr,
|
||||
static int parse_options_usage(struct parse_opt_ctx_t *ctx,
|
||||
const char * const *usagestr,
|
||||
const struct option *opts, int err);
|
||||
|
||||
#define OPT_SHORT 1
|
||||
|
@ -351,7 +352,8 @@ void parse_options_start(struct parse_opt_ctx_t *ctx,
|
|||
die("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
|
||||
}
|
||||
|
||||
static int usage_with_options_internal(const char * const *,
|
||||
static int usage_with_options_internal(struct parse_opt_ctx_t *,
|
||||
const char * const *,
|
||||
const struct option *, int, int);
|
||||
|
||||
int parse_options_step(struct parse_opt_ctx_t *ctx,
|
||||
|
@ -380,10 +382,10 @@ int parse_options_step(struct parse_opt_ctx_t *ctx,
|
|||
if (arg[1] != '-') {
|
||||
ctx->opt = arg + 1;
|
||||
if (internal_help && *ctx->opt == 'h')
|
||||
return parse_options_usage(usagestr, options, 0);
|
||||
return parse_options_usage(ctx, usagestr, options, 0);
|
||||
switch (parse_short_opt(ctx, options)) {
|
||||
case -1:
|
||||
return parse_options_usage(usagestr, options, 1);
|
||||
return parse_options_usage(ctx, usagestr, options, 1);
|
||||
case -2:
|
||||
goto unknown;
|
||||
}
|
||||
|
@ -391,10 +393,10 @@ int parse_options_step(struct parse_opt_ctx_t *ctx,
|
|||
check_typos(arg + 1, options);
|
||||
while (ctx->opt) {
|
||||
if (internal_help && *ctx->opt == 'h')
|
||||
return parse_options_usage(usagestr, options, 0);
|
||||
return parse_options_usage(ctx, usagestr, options, 0);
|
||||
switch (parse_short_opt(ctx, options)) {
|
||||
case -1:
|
||||
return parse_options_usage(usagestr, options, 1);
|
||||
return parse_options_usage(ctx, usagestr, options, 1);
|
||||
case -2:
|
||||
/* fake a short option thing to hide the fact that we may have
|
||||
* started to parse aggregated stuff
|
||||
|
@ -418,12 +420,12 @@ int parse_options_step(struct parse_opt_ctx_t *ctx,
|
|||
}
|
||||
|
||||
if (internal_help && !strcmp(arg + 2, "help-all"))
|
||||
return usage_with_options_internal(usagestr, options, 1, 0);
|
||||
return usage_with_options_internal(ctx, usagestr, options, 1, 0);
|
||||
if (internal_help && !strcmp(arg + 2, "help"))
|
||||
return parse_options_usage(usagestr, options, 0);
|
||||
return parse_options_usage(ctx, usagestr, options, 0);
|
||||
switch (parse_long_opt(ctx, arg + 2, options)) {
|
||||
case -1:
|
||||
return parse_options_usage(usagestr, options, 1);
|
||||
return parse_options_usage(ctx, usagestr, options, 1);
|
||||
case -2:
|
||||
goto unknown;
|
||||
}
|
||||
|
@ -485,14 +487,18 @@ static int usage_argh(const struct option *opts, FILE *outfile)
|
|||
#define USAGE_OPTS_WIDTH 24
|
||||
#define USAGE_GAP 2
|
||||
|
||||
static int usage_with_options_internal(const char * const *usagestr,
|
||||
const struct option *opts, int full, int err)
|
||||
static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
|
||||
const char * const *usagestr,
|
||||
const struct option *opts, int full, int err)
|
||||
{
|
||||
FILE *outfile = err ? stderr : stdout;
|
||||
|
||||
if (!usagestr)
|
||||
return PARSE_OPT_HELP;
|
||||
|
||||
if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
|
||||
fprintf(outfile, "cat <<\\EOF\n");
|
||||
|
||||
fprintf(outfile, "usage: %s\n", *usagestr++);
|
||||
while (*usagestr && **usagestr)
|
||||
fprintf(outfile, " or: %s\n", *usagestr++);
|
||||
|
@ -548,13 +554,16 @@ static int usage_with_options_internal(const char * const *usagestr,
|
|||
}
|
||||
fputc('\n', outfile);
|
||||
|
||||
if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
|
||||
fputs("EOF\n", outfile);
|
||||
|
||||
return PARSE_OPT_HELP;
|
||||
}
|
||||
|
||||
void usage_with_options(const char * const *usagestr,
|
||||
const struct option *opts)
|
||||
{
|
||||
usage_with_options_internal(usagestr, opts, 0, 1);
|
||||
usage_with_options_internal(NULL, usagestr, opts, 0, 1);
|
||||
exit(129);
|
||||
}
|
||||
|
||||
|
@ -566,10 +575,11 @@ void usage_msg_opt(const char *msg,
|
|||
usage_with_options(usagestr, options);
|
||||
}
|
||||
|
||||
static int parse_options_usage(const char * const *usagestr,
|
||||
static int parse_options_usage(struct parse_opt_ctx_t *ctx,
|
||||
const char * const *usagestr,
|
||||
const struct option *opts, int err)
|
||||
{
|
||||
return usage_with_options_internal(usagestr, opts, 0, err);
|
||||
return usage_with_options_internal(ctx, usagestr, opts, 0, err);
|
||||
}
|
||||
|
||||
|
||||
|
|
|
@ -37,6 +37,7 @@ enum parse_opt_option_flags {
|
|||
PARSE_OPT_NODASH = 32,
|
||||
PARSE_OPT_LITERAL_ARGHELP = 64,
|
||||
PARSE_OPT_NEGHELP = 128,
|
||||
PARSE_OPT_SHELL_EVAL = 256
|
||||
};
|
||||
|
||||
struct option;
|
||||
|
|
|
@ -3,7 +3,8 @@
|
|||
test_description='test git rev-parse --parseopt'
|
||||
. ./test-lib.sh
|
||||
|
||||
cat > expect <<EOF
|
||||
cat > expect <<\END_EXPECT
|
||||
cat <<\EOF
|
||||
usage: some-command [options] <args>...
|
||||
|
||||
some-command does foo and bar!
|
||||
|
@ -19,6 +20,7 @@ Extras
|
|||
--extra1 line above used to cause a segfault but no longer does
|
||||
|
||||
EOF
|
||||
END_EXPECT
|
||||
|
||||
cat > optionspec << EOF
|
||||
some-command [options] <args>...
|
||||
|
|
Loading…
Reference in a new issue