git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Unexpected exit code for --help with rev-parse --parseopt

From
brian m. carlson <sandals@crustytoothpaste.net>
Date
Mar 15, 2026, 00:52 UTC
Message-ID
<abYCxrEEPaI21g3H@fruit.crustytoothpaste.net>

I use git rev-parse --parseopt to parse command-line options in various script. I've noticed that it exits 129 if the options are invalid, which is fine, but that it also exits 129 if --help or -h are given, which is not.

The standard philosophy is that if the user explicitly asked for help, then help output should be printed to standard output (since that's what the user asked for) and it should exit 0, since the program fulfilled the user's request successfully. If the help output is provided because the user provided an invalid option or argument, then the output should Go to standard error (since it's an error message) and the program should exit unsuccessfully (since it did not fulfill the user's request successfully).

Git gets the location of the output just fine, but currently there's no way for a program to detect the help output and exit successfully. Note that Git subcommands don't have this problem because Git itself intercepts the help output and sends it to man (or whatever the user has configured), which then exits successfully.

I'd like to fix this in git rev-parse --parseopt (that is, I am willing to send a patch), but I'm unsure about the best way to go about this. Does anyone have ideas about how they'd like this to be fixed? I could simply change the exit code in this case or I could add an option to control this behaviour for backwards compatibility.

Example:

---- #!/bin/sh

OPTS_SPEC="\ foo-cmd [<options>] <args>...

Do stuff. -- h,help! show this help

o,output= output to this file d,dir= specify dependencies relative to this directory "

main () {
    eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)"
    # Do something with the options here.
}

main "$@" ----

Output:

---- % ./foo-cmd --help >/dev/null; echo $? 129 % ./foo-cmd -h >/dev/null; echo $? 129 % ./foo-cmd --bassoon >/dev/null; echo $? error: unknown option `bassoon' usage: foo-cmd [<options>] <args>...

    Do stuff.
    -h, --help            show this help
    -o, --[no-]output ... output to this file
    -d, --[no-]dir ...    specify dependencies relative to this directory

129 ----

-- 
brian m. carlson (they/them)
Toronto, Ontario, CA
Next: Jeff King
Message 1 of 39 in “Unexpected exit code for --help with rev-parse --parseopt”
  1. brian m. carlsonMar 15, 2026
  2. Jeff KingMar 15, 2026
  3. brian m. carlsonMar 15, 2026
  4. Jeff KingMar 15, 2026
  5. rev-parse: have --parseopt callers exit 0 on --helpbrian m. carlson, Mar 16, 2026
  6. Junio C HamanoMar 17, 2026
  7. brian m. carlsonMar 17, 2026
  8. Jeff KingMar 17, 2026
  9. Jeff KingMar 17, 2026
  10. Junio C HamanoMar 17, 2026
  11. Jeff KingMar 17, 2026
  12. brian m. carlsonMar 18, 2026
  13. Jeff KingMar 18, 2026
  14. Junio C HamanoMar 18, 2026
  15. 0/4 rev-parse: exit 0 on --helpbrian m. carlson, Jul 1, 2026
  16. 3/4 rev-parse: have --parseopt callers exit 0 on --helpbrian m. carlson, Jul 1, 2026
  17. Junio C HamanoJul 1, 2026
  18. 1/4 t1517: skip svn tests if svn is not installedbrian m. carlson, Jul 1, 2026
  19. Junio C HamanoJul 1, 2026
  20. Junio C HamanoJul 1, 2026
  21. brian m. carlsonJul 2, 2026
  22. Jeff KingJul 2, 2026
  23. Junio C HamanoJul 3, 2026
  24. Jeff KingJul 4, 2026
  25. 4/4 parse-options: exit 0 on -hbrian m. carlson, Jul 1, 2026
  26. 2/4 parse-options: add a separate case for help output on errorbrian m. carlson, Jul 1, 2026
  27. Jeff KingJul 2, 2026
  28. Junio C HamanoJul 1, 2026
  29. Jeff KingJul 2, 2026
  30. Junio C HamanoJul 3, 2026
  31. 0/4 parseopt: exit 0 on helpbrian m. carlson, Jul 8, 2026
  32. 1/4 t1517: skip svn tests if svn is not installedbrian m. carlson, Jul 8, 2026
  33. Junio C HamanoJul 8, 2026
  34. 3/4 rev-parse: have --parseopt callers exit 0 on --helpbrian m. carlson, Jul 8, 2026
  35. 2/4 parse-options: add a separate case for help output on errorbrian m. carlson, Jul 8, 2026
  36. Junio C HamanoJul 8, 2026
  37. 4/4 parse-options: exit 0 on -hbrian m. carlson, Jul 8, 2026
  38. Jeff KingJul 8, 2026
  39. Junio C HamanoJul 8, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.