parse-options.h

   1 #ifndef PARSE_OPTIONS_H
   2 #define PARSE_OPTIONS_H
   3
   4 /**
   5  * Refer to Documentation/technical/api-parse-options.txt for the API doc.
   6  */
   7
   8 enum parse_opt_type {
   9         /* special types */
  10         OPTION_END,
  11         OPTION_GROUP,
  12         OPTION_NUMBER,
  13         OPTION_ALIAS,
  14         OPTION_SUBCOMMAND,
  15         /* options with no arguments */
  16         OPTION_BIT,
  17         OPTION_NEGBIT,
  18         OPTION_BITOP,
  19         OPTION_COUNTUP,
  20         OPTION_SET_INT,
  21         /* options with arguments (usually) */
  22         OPTION_STRING,
  23         OPTION_INTEGER,
  24         OPTION_MAGNITUDE,
  25         OPTION_CALLBACK,
  26         OPTION_LOWLEVEL_CALLBACK,
  27         OPTION_FILENAME
  28 };
  29
  30 enum parse_opt_flags {
  31         PARSE_OPT_KEEP_DASHDASH = 1 << 0,
  32         PARSE_OPT_STOP_AT_NON_OPTION = 1 << 1,
  33         PARSE_OPT_KEEP_ARGV0 = 1 << 2,
  34         PARSE_OPT_KEEP_UNKNOWN_OPT = 1 << 3,
  35         PARSE_OPT_NO_INTERNAL_HELP = 1 << 4,
  36         PARSE_OPT_ONE_SHOT = 1 << 5,
  37         PARSE_OPT_SHELL_EVAL = 1 << 6,
  38         PARSE_OPT_SUBCOMMAND_OPTIONAL = 1 << 7,
  39 };
  40
  41 enum parse_opt_option_flags {
  42         PARSE_OPT_OPTARG  = 1 << 0,
  43         PARSE_OPT_NOARG   = 1 << 1,
  44         PARSE_OPT_NONEG   = 1 << 2,
  45         PARSE_OPT_HIDDEN  = 1 << 3,
  46         PARSE_OPT_LASTARG_DEFAULT = 1 << 4,
  47         PARSE_OPT_NODASH = 1 << 5,
  48         PARSE_OPT_LITERAL_ARGHELP = 1 << 6,
  49         PARSE_OPT_FROM_ALIAS = 1 << 7,
  50         PARSE_OPT_NOCOMPLETE = 1 << 9,
  51         PARSE_OPT_COMP_ARG = 1 << 10,
  52         PARSE_OPT_CMDMODE = 1 << 11,
  53 };
  54
  55 enum parse_opt_result {
  56         PARSE_OPT_COMPLETE = -3,
  57         PARSE_OPT_HELP = -2,
  58         PARSE_OPT_ERROR = -1,   /* must be the same as error() */
  59         PARSE_OPT_DONE = 0,     /* fixed so that "return 0" works */
  60         PARSE_OPT_NON_OPTION,
  61         PARSE_OPT_SUBCOMMAND,
  62         PARSE_OPT_UNKNOWN
  63 };
  64
  65 struct option;
  66 typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
  67
  68 struct parse_opt_ctx_t;
  69 typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
  70                                               const struct option *opt,
  71                                               const char *arg, int unset);
  72
  73 typedef int parse_opt_subcommand_fn(int argc, const char **argv,
  74                                     const char *prefix);
  75
  76 /*
  77  * `type`::
  78  *   holds the type of the option, you must have an OPTION_END last in your
  79  *   array.
  80  *
  81  * `short_name`::
  82  *   the character to use as a short option name, '\0' if none.
  83  *
  84  * `long_name`::
  85  *   the long option (without the leading dashes) or subcommand name,
  86  *   NULL if none.
  87  *
  88  * `value`::
  89  *   stores pointers to the values to be filled.
  90  *
  91  * `argh`::
  92  *   token to explain the kind of argument this option wants. Does not
  93  *   begin in capital letter, and does not end with a full stop.
  94  *   Should be wrapped by N_() for translation.
  95  *   Is automatically enclosed in brackets when printed, unless it
  96  *   contains any of the following characters: ()<>[]|
  97  *   E.g. "name" is shown as "<name>" to indicate that a name value
  98  *   needs to be supplied, not the literal string "name", but
  99  *   "<start>,<end>" and "(this|that)" are printed verbatim.
 100  *
 101  * `help`::
 102  *   the short help associated to what the option does.
 103  *   Must never be NULL (except for OPTION_END and OPTION_SUBCOMMAND).
 104  *   OPTION_GROUP uses this pointer to store the group header.
 105  *   Should be wrapped by N_() for translation.
 106  *
 107  * `flags`::
 108  *   mask of parse_opt_option_flags.
 109  *   PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
 110  *   PARSE_OPT_NOARG: says that this option does not take an argument
 111  *   PARSE_OPT_NONEG: says that this option cannot be negated
 112  *   PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
 113  *                     shown only in the full usage.
 114  *   PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
 115  *                              value if no argument is given when the option
 116  *                              is last on the command line. If the option is
 117  *                              not last it will require an argument.
 118  *                              Should not be used with PARSE_OPT_OPTARG.
 119  *   PARSE_OPT_NODASH: this option doesn't start with a dash; can only be a
 120  *                     short option and can't accept arguments.
 121  *   PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
 122  *                              (i.e. '<argh>') in the help message.
 123  *                              Useful for options with multiple parameters.
 124  *   PARSE_OPT_NOCOMPLETE: by default all visible options are completable
 125  *                         by git-completion.bash. This option suppresses that.
 126  *   PARSE_OPT_COMP_ARG: this option forces to git-completion.bash to
 127  *                       complete an option as --name= not --name even if
 128  *                       the option takes optional argument.
 129  *
 130  * `callback`::
 131  *   pointer to the callback to use for OPTION_CALLBACK
 132  *
 133  * `defval`::
 134  *   default value to fill (*->value) with for PARSE_OPT_OPTARG.
 135  *   OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
 136  *   CALLBACKS can use it like they want.
 137  *
 138  * `ll_callback`::
 139  *   pointer to the callback to use for OPTION_LOWLEVEL_CALLBACK
 140  *
 141  * `subcommand_fn`::
 142  *   pointer to a function to use for OPTION_SUBCOMMAND.
 143  *   It will be put in value when the subcommand is given on the command line.
 144  */
 145 struct option {
 146         enum parse_opt_type type;
 147         int short_name;
 148         const char *long_name;
 149         void *value;
 150         const char *argh;
 151         const char *help;
 152
 153         enum parse_opt_option_flags flags;
 154         parse_opt_cb *callback;
 155         intptr_t defval;
 156         parse_opt_ll_cb *ll_callback;
 157         intptr_t extra;
 158         parse_opt_subcommand_fn *subcommand_fn;
 159 };
 160
 161 #define OPT_BIT_F(s, l, v, h, b, f) { \
 162         .type = OPTION_BIT, \
 163         .short_name = (s), \
 164         .long_name = (l), \
 165         .value = (v), \
 166         .help = (h), \
 167         .flags = PARSE_OPT_NOARG|(f), \
 168         .callback = NULL, \
 169         .defval = (b), \
 170 }
 171 #define OPT_COUNTUP_F(s, l, v, h, f) { \
 172         .type = OPTION_COUNTUP, \
 173         .short_name = (s), \
 174         .long_name = (l), \
 175         .value = (v), \
 176         .help = (h), \
 177         .flags = PARSE_OPT_NOARG|(f), \
 178 }
 179 #define OPT_SET_INT_F(s, l, v, h, i, f) { \
 180         .type = OPTION_SET_INT, \
 181         .short_name = (s), \
 182         .long_name = (l), \
 183         .value = (v), \
 184         .help = (h), \
 185         .flags = PARSE_OPT_NOARG | (f), \
 186         .defval = (i), \
 187 }
 188 #define OPT_BOOL_F(s, l, v, h, f)   OPT_SET_INT_F(s, l, v, h, 1, f)
 189 #define OPT_CALLBACK_F(s, l, v, a, h, f, cb) { \
 190         .type = OPTION_CALLBACK, \
 191         .short_name = (s), \
 192         .long_name = (l), \
 193         .value = (v), \
 194         .argh = (a), \
 195         .help = (h), \
 196         .flags = (f), \
 197         .callback = (cb), \
 198 }
 199 #define OPT_STRING_F(s, l, v, a, h, f) { \
 200         .type = OPTION_STRING, \
 201         .short_name = (s), \
 202         .long_name = (l), \
 203         .value = (v), \
 204         .argh = (a), \
 205         .help = (h), \
 206         .flags = (f), \
 207 }
 208 #define OPT_INTEGER_F(s, l, v, h, f) { \
 209         .type = OPTION_INTEGER, \
 210         .short_name = (s), \
 211         .long_name = (l), \
 212         .value = (v), \
 213         .argh = N_("n"), \
 214         .help = (h), \
 215         .flags = (f), \
 216 }
 217
 218 #define OPT_END() { \
 219         .type = OPTION_END, \
 220 }
 221 #define OPT_GROUP(h) { \
 222         .type = OPTION_GROUP, \
 223         .help = (h), \
 224 }
 225 #define OPT_BIT(s, l, v, h, b)      OPT_BIT_F(s, l, v, h, b, 0)
 226 #define OPT_BITOP(s, l, v, h, set, clear) { \
 227         .type = OPTION_BITOP, \
 228         .short_name = (s), \
 229         .long_name = (l), \
 230         .value = (v), \
 231         .help = (h), \
 232         .flags = PARSE_OPT_NOARG|PARSE_OPT_NONEG, \
 233         .defval = (set), \
 234         .extra = (clear), \
 235 }
 236 #define OPT_NEGBIT(s, l, v, h, b) { \
 237         .type = OPTION_NEGBIT, \
 238         .short_name = (s), \
 239         .long_name = (l), \
 240         .value = (v), \
 241         .help = (h), \
 242         .flags = PARSE_OPT_NOARG, \
 243         .defval = (b), \
 244 }
 245 #define OPT_COUNTUP(s, l, v, h)     OPT_COUNTUP_F(s, l, v, h, 0)
 246 #define OPT_SET_INT(s, l, v, h, i)  OPT_SET_INT_F(s, l, v, h, i, 0)
 247 #define OPT_BOOL(s, l, v, h)        OPT_BOOL_F(s, l, v, h, 0)
 248 #define OPT_HIDDEN_BOOL(s, l, v, h) { \
 249         .type = OPTION_SET_INT, \
 250         .short_name = (s), \
 251         .long_name = (l), \
 252         .value = (v), \
 253         .help = (h), \
 254         .flags = PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, \
 255         .defval = 1, \
 256 }
 257 #define OPT_CMDMODE_F(s, l, v, h, i, f) { \
 258         .type = OPTION_SET_INT, \
 259         .short_name = (s), \
 260         .long_name = (l), \
 261         .value = (v), \
 262         .help = (h), \
 263         .flags = PARSE_OPT_CMDMODE|PARSE_OPT_NOARG|PARSE_OPT_NONEG | (f), \
 264         .defval = (i), \
 265 }
 266 #define OPT_CMDMODE(s, l, v, h, i)  OPT_CMDMODE_F(s, l, v, h, i, 0)
 267
 268 #define OPT_INTEGER(s, l, v, h)     OPT_INTEGER_F(s, l, v, h, 0)
 269 #define OPT_MAGNITUDE(s, l, v, h) { \
 270         .type = OPTION_MAGNITUDE, \
 271         .short_name = (s), \
 272         .long_name = (l), \
 273         .value = (v), \
 274         .argh = N_("n"), \
 275         .help = (h), \
 276         .flags = PARSE_OPT_NONEG, \
 277 }
 278 #define OPT_STRING(s, l, v, a, h)   OPT_STRING_F(s, l, v, a, h, 0)
 279 #define OPT_STRING_LIST(s, l, v, a, h) { \
 280         .type = OPTION_CALLBACK, \
 281         .short_name = (s), \
 282         .long_name = (l), \
 283         .value = (v), \
 284         .argh = (a), \
 285         .help = (h), \
 286         .callback = &parse_opt_string_list, \
 287 }
 288 #define OPT_UYN(s, l, v, h) { \
 289         .type = OPTION_CALLBACK, \
 290         .short_name = (s), \
 291         .long_name = (l), \
 292         .value = (v), \
 293         .help = (h), \
 294         .flags = PARSE_OPT_NOARG, \
 295         .callback = &parse_opt_tertiary, \
 296 }
 297 #define OPT_EXPIRY_DATE(s, l, v, h) { \
 298         .type = OPTION_CALLBACK, \
 299         .short_name = (s), \
 300         .long_name = (l), \
 301         .value = (v), \
 302         .argh = N_("expiry-date"), \
 303         .help = (h), \
 304         .callback = parse_opt_expiry_date_cb, \
 305 }
 306 #define OPT_CALLBACK(s, l, v, a, h, cb) OPT_CALLBACK_F(s, l, v, a, h, 0, cb)
 307 #define OPT_NUMBER_CALLBACK(v, h, cb) { \
 308         .type = OPTION_NUMBER, \
 309         .value = (v), \
 310         .help = (h), \
 311         .flags = PARSE_OPT_NOARG | PARSE_OPT_NONEG, \
 312         .callback = (cb), \
 313 }
 314 #define OPT_FILENAME(s, l, v, h) { \
 315         .type = OPTION_FILENAME, \
 316         .short_name = (s), \
 317         .long_name = (l), \
 318         .value = (v), \
 319         .argh = N_("file"), \
 320         .help = (h), \
 321 }
 322 #define OPT_COLOR_FLAG(s, l, v, h) { \
 323         .type = OPTION_CALLBACK, \
 324         .short_name = (s), \
 325         .long_name = (l), \
 326         .value = (v), \
 327         .argh = N_("when"), \
 328         .help = (h), \
 329         .flags = PARSE_OPT_OPTARG, \
 330         .callback = parse_opt_color_flag_cb, \
 331         .defval = (intptr_t)"always", \
 332 }
 333
 334 #define OPT_NOOP_NOARG(s, l) { \
 335         .type = OPTION_CALLBACK, \
 336         .short_name = (s), \
 337         .long_name = (l), \
 338         .help = N_("no-op (backward compatibility)"), \
 339         .flags = PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, \
 340         .callback = parse_opt_noop_cb, \
 341 }
 342
 343 #define OPT_ALIAS(s, l, source_long_name) { \
 344         .type = OPTION_ALIAS, \
 345         .short_name = (s), \
 346         .long_name = (l), \
 347         .value = (source_long_name), \
 348 }
 349
 350 #define OPT_SUBCOMMAND_F(l, v, fn, f) { \
 351         .type = OPTION_SUBCOMMAND, \
 352         .long_name = (l), \
 353         .value = (v), \
 354         .flags = (f), \
 355         .subcommand_fn = (fn), \
 356 }
 357 #define OPT_SUBCOMMAND(l, v, fn)    OPT_SUBCOMMAND_F((l), (v), (fn), 0)
 358
 359 /*
 360  * parse_options() will filter out the processed options and leave the
 361  * non-option arguments in argv[]. argv0 is assumed program name and
 362  * skipped.
 363  *
 364  * usagestr strings should be marked for translation with N_().
 365  *
 366  * Returns the number of arguments left in argv[].
 367  *
 368  * In one-shot mode, argv0 is not a program name, argv[] is left
 369  * untouched and parse_options() returns the number of options
 370  * processed.
 371  */
 372 int parse_options(int argc, const char **argv, const char *prefix,
 373                   const struct option *options,
 374                   const char * const usagestr[],
 375                   enum parse_opt_flags flags);
 376
 377 NORETURN void usage_with_options(const char * const *usagestr,
 378                                  const struct option *options);
 379
 380 NORETURN void usage_msg_opt(const char *msg,
 381                             const char * const *usagestr,
 382                             const struct option *options);
 383
 384 /**
 385  * usage_msg_optf() is like usage_msg_opt() except that the first
 386  * argument is a format string, and optional format arguments follow
 387  * after the 3rd option.
 388  */
 389 __attribute__((format (printf,1,4)))
 390 void NORETURN usage_msg_optf(const char *fmt,
 391                              const char * const *usagestr,
 392                              const struct option *options, ...);
 393
 394 void die_for_incompatible_opt4(int opt1, const char *opt1_name,
 395                                int opt2, const char *opt2_name,
 396                                int opt3, const char *opt3_name,
 397                                int opt4, const char *opt4_name);
 398
 399
 400 static inline void die_for_incompatible_opt3(int opt1, const char *opt1_name,
 401                                              int opt2, const char *opt2_name,
 402                                              int opt3, const char *opt3_name)
 403 {
 404         die_for_incompatible_opt4(opt1, opt1_name,
 405                                   opt2, opt2_name,
 406                                   opt3, opt3_name,
 407                                   0, "");
 408 }
 409
 410 /*
 411  * Use these assertions for callbacks that expect to be called with NONEG and
 412  * NOARG respectively, and do not otherwise handle the "unset" and "arg"
 413  * parameters.
 414  */
 415 #define BUG_ON_OPT_NEG(unset) do { \
 416         if ((unset)) \
 417                 BUG("option callback does not expect negation"); \
 418 } while (0)
 419 #define BUG_ON_OPT_ARG(arg) do { \
 420         if ((arg)) \
 421                 BUG("option callback does not expect an argument"); \
 422 } while (0)
 423
 424 /*
 425  * Similar to the assertions above, but checks that "arg" is always non-NULL.
 426  * This assertion also implies BUG_ON_OPT_NEG(), letting you declare both
 427  * assertions in a single line.
 428  */
 429 #define BUG_ON_OPT_NEG_NOARG(unset, arg) do { \
 430         BUG_ON_OPT_NEG(unset); \
 431         if(!(arg)) \
 432                 BUG("option callback expects an argument"); \
 433 } while(0)
 434
 435 /*----- incremental advanced APIs -----*/
 436
 437 /*
 438  * It's okay for the caller to consume argv/argc in the usual way.
 439  * Other fields of that structure are private to parse-options and should not
 440  * be modified in any way.
 441  */
 442 struct parse_opt_ctx_t {
 443         const char **argv;
 444         const char **out;
 445         int argc, cpidx, total;
 446         const char *opt;
 447         enum parse_opt_flags flags;
 448         unsigned has_subcommands;
 449         const char *prefix;
 450         const char **alias_groups; /* must be in groups of 3 elements! */
 451         struct option *updated_options;
 452 };
 453
 454 void parse_options_start(struct parse_opt_ctx_t *ctx,
 455                          int argc, const char **argv, const char *prefix,
 456                          const struct option *options,
 457                          enum parse_opt_flags flags);
 458
 459 enum parse_opt_result parse_options_step(struct parse_opt_ctx_t *ctx,
 460                                          const struct option *options,
 461                                          const char * const usagestr[]);
 462
 463 int parse_options_end(struct parse_opt_ctx_t *ctx);
 464
 465 struct option *parse_options_dup(const struct option *a);
 466 struct option *parse_options_concat(const struct option *a, const struct option *b);
 467
 468 /*----- some often used options -----*/
 469 int parse_opt_abbrev_cb(const struct option *, const char *, int);
 470 int parse_opt_expiry_date_cb(const struct option *, const char *, int);
 471 int parse_opt_color_flag_cb(const struct option *, const char *, int);
 472 int parse_opt_verbosity_cb(const struct option *, const char *, int);
 473 /* value is struct oid_array* */
 474 int parse_opt_object_name(const struct option *, const char *, int);
 475 /* value is struct object_id* */
 476 int parse_opt_object_id(const struct option *, const char *, int);
 477 int parse_opt_commits(const struct option *, const char *, int);
 478 int parse_opt_commit(const struct option *, const char *, int);
 479 int parse_opt_tertiary(const struct option *, const char *, int);
 480 int parse_opt_string_list(const struct option *, const char *, int);
 481 int parse_opt_noop_cb(const struct option *, const char *, int);
 482 int parse_opt_passthru(const struct option *, const char *, int);
 483 int parse_opt_passthru_argv(const struct option *, const char *, int);
 484 /* value is enum branch_track* */
 485 int parse_opt_tracking_mode(const struct option *, const char *, int);
 486
 487 #define OPT__VERBOSE(var, h)  OPT_COUNTUP('v', "verbose", (var), (h))
 488 #define OPT__QUIET(var, h)    OPT_COUNTUP('q', "quiet",   (var), (h))
 489 #define OPT__VERBOSITY(var) { \
 490         .type = OPTION_CALLBACK, \
 491         .short_name = 'v', \
 492         .long_name = "verbose", \
 493         .value = (var), \
 494         .help = N_("be more verbose"), \
 495         .flags = PARSE_OPT_NOARG, \
 496         .callback = &parse_opt_verbosity_cb, \
 497 }, { \
 498         .type = OPTION_CALLBACK, \
 499         .short_name = 'q', \
 500         .long_name = "quiet", \
 501         .value = (var), \
 502         .help = N_("be more quiet"), \
 503         .flags = PARSE_OPT_NOARG, \
 504         .callback = &parse_opt_verbosity_cb, \
 505 }
 506 #define OPT__DRY_RUN(var, h)  OPT_BOOL('n', "dry-run", (var), (h))
 507 #define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force",   (var), (h), (f))
 508 #define OPT__ABBREV(var) { \
 509         .type = OPTION_CALLBACK, \
 510         .long_name = "abbrev", \
 511         .value = (var), \
 512         .argh = N_("n"), \
 513         .help = N_("use <n> digits to display object names"), \
 514         .flags = PARSE_OPT_OPTARG, \
 515         .callback = &parse_opt_abbrev_cb, \
 516 }
 517 #define OPT__SUPER_PREFIX(var) \
 518         OPT_STRING_F(0, "super-prefix", (var), N_("prefix"), \
 519                 N_("prefixed path to initial superproject"), PARSE_OPT_HIDDEN)
 520
 521 #define OPT__COLOR(var, h) \
 522         OPT_COLOR_FLAG(0, "color", (var), (h))
 523 #define OPT_COLUMN(s, l, v, h) { \
 524         .type = OPTION_CALLBACK, \
 525         .short_name = (s), \
 526         .long_name = (l), \
 527         .value = (v), \
 528         .argh = N_("style"), \
 529         .help = (h), \
 530         .flags = PARSE_OPT_OPTARG, \
 531         .callback = parseopt_column_callback, \
 532 }
 533 #define OPT_PASSTHRU(s, l, v, a, h, f) { \
 534         .type = OPTION_CALLBACK, \
 535         .short_name = (s), \
 536         .long_name = (l), \
 537         .value = (v), \
 538         .argh = (a), \
 539         .help = (h), \
 540         .flags = (f), \
 541         .callback = parse_opt_passthru, \
 542 }
 543 #define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) { \
 544         .type = OPTION_CALLBACK, \
 545         .short_name = (s), \
 546         .long_name = (l), \
 547         .value = (v), \
 548         .argh = (a), \
 549         .help = (h), \
 550         .flags = (f), \
 551         .callback = parse_opt_passthru_argv, \
 552 }
 553 #define _OPT_CONTAINS_OR_WITH(l, v, h, f) { \
 554         .type = OPTION_CALLBACK, \
 555         .long_name = (l), \
 556         .value = (v), \
 557         .argh = N_("commit"), \
 558         .help = (h), \
 559         .flags = PARSE_OPT_LASTARG_DEFAULT | (f), \
 560         .callback = parse_opt_commits, \
 561         .defval = (intptr_t) "HEAD", \
 562 }
 563 #define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
 564 #define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
 565 #define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
 566 #define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
 567 #define OPT_CLEANUP(v) OPT_STRING(0, "cleanup", v, N_("mode"), N_("how to strip spaces and #comments from message"))
 568 #define OPT_PATHSPEC_FROM_FILE(v) OPT_FILENAME(0, "pathspec-from-file", v, N_("read pathspec from file"))
 569 #define OPT_PATHSPEC_FILE_NUL(v)  OPT_BOOL(0, "pathspec-file-nul", v, N_("with --pathspec-from-file, pathspec elements are separated with NUL character"))
 570 #define OPT_AUTOSTASH(v) OPT_BOOL(0, "autostash", v, N_("automatically stash/stash pop before and after"))
 571
 572 #endif