diff options
| author | SZEDER Gábor <szeder.dev@gmail.com> | 2022-08-19 19:03:58 +0300 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2022-08-19 21:13:14 +0300 |
| commit | a9126b92a2adddb58522a342cdbaf0aec4d879bf (patch) | |
| tree | 4c29bfb5825deb5a0a4953fe33a83ac0b08e1d1f /parse-options.h | |
| parent | 99d86d60e59e11cbc46766346e3e379164a6e4df (diff) | |
parse-options: clarify the limitations of PARSE_OPT_NODASH
Update the comment documenting 'struct option' to clarify that
PARSE_OPT_NODASH can only be an argumentless short option; see
51a9949eda (parseopt: add PARSE_OPT_NODASH, 2009-05-07).
Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'parse-options.h')
| -rw-r--r-- | parse-options.h | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/parse-options.h b/parse-options.h index 591df64191..8cbfc7e8bf 100644 --- a/parse-options.h +++ b/parse-options.h @@ -109,7 +109,8 @@ typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx, * is last on the command line. If the option is * not last it will require an argument. * Should not be used with PARSE_OPT_OPTARG. - * PARSE_OPT_NODASH: this option doesn't start with a dash. + * PARSE_OPT_NODASH: this option doesn't start with a dash; can only be a + * short option and can't accept arguments. * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets * (i.e. '<argh>') in the help message. * Useful for options with multiple parameters. |