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>
SZEDER Gábor committed
Aug 19, 2022 at 18:03 UTC
a9126b92a2adddb58522a342cdbaf0aec4d879bf
1 file changed
+2
-1
parse-options.h
+2
-1
@@ -109,7 +109,8 @@ typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
109
* is last on the command line. If the option is
110
* not last it will require an argument.
111
* Should not be used with PARSE_OPT_OPTARG.
112
- * PARSE_OPT_NODASH: this option doesn't start with a dash.
112
+ * PARSE_OPT_NODASH: this option doesn't start with a dash; can only be a
113
+ * short option and can't accept arguments.
114
* PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
115
* (i.e. '<argh>') in the help message.
116
* Useful for options with multiple parameters.