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

[PATCH 01/10] parse-options.h: move PARSE_OPT_SHELL_EVAL between enums

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Sep 28, 2021, 13:14 UTC
Message-ID
<patch-01.10-19d1573a4e0-20210928T130905Z-avarab@gmail.com>
In-Reply-To
<cover-00.10-00000000000-20210928T130905Z-avarab@gmail.com>

Fix a bad landmine of a bug which has been with us ever since PARSE_OPT_SHELL_EVAL was added in 47e9cd28f8a (parseopt: wrap rev-parse --parseopt usage for eval consumption, 2010-06-12).

It's an argument to parse_options() and should therefore be in "enum parse_opt_flags", but it was added to the per-option "enum parse_opt_option_flags" by mistake.

Therefore as soon as we'd have an enum member in the former that reached its value of "1 << 8" we'd run into a seemingly bizarre bug where that new option would turn on the unrelated PARSE_OPT_SHELL_EVAL in "git rev-parse --parseopt" by proxy.

I manually checked that no other enum members suffered from such overlap, by setting the values to non-overlapping values, and making the relevant codepaths BUG() out if the given value was above/below the expected (excluding flags=0 in the case of "enum parse_opt_flags").

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 parse-options.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/parse-options.h b/parse-options.h
index 39d90882548..3a3176ae65c 100644
--- a/parse-options.h
+++ b/parse-options.h
@@ -33,6 +33,7 @@ enum parse_opt_flags {
 	PARSE_OPT_KEEP_UNKNOWN = 1 << 3,
 	PARSE_OPT_NO_INTERNAL_HELP = 1 << 4,
 	PARSE_OPT_ONE_SHOT = 1 << 5,
+	PARSE_OPT_SHELL_EVAL = 1 << 6,
 };
 
 enum parse_opt_option_flags {
@@ -44,7 +45,6 @@ enum parse_opt_option_flags {
 	PARSE_OPT_NODASH = 1 << 5,
 	PARSE_OPT_LITERAL_ARGHELP = 1 << 6,
 	PARSE_OPT_FROM_ALIAS = 1 << 7,
-	PARSE_OPT_SHELL_EVAL = 1 << 8,
 	PARSE_OPT_NOCOMPLETE = 1 << 9,
 	PARSE_OPT_COMP_ARG = 1 << 10,
 	PARSE_OPT_CMDMODE = 1 << 11,
-- 
2.33.0.1340.ge9f77250f2b
Previous: Ævar Arnfjörð BjarmasonNext: Ævar Arnfjörð Bjarmason
Message 2 of 61 in “fix bug, use existing enums”
  1. 00/10 fix bug, use existing enumsÆvar Arnfjörð Bjarmason, Sep 28, 2021
  2. 01/10 parse-options.h: move PARSE_OPT_SHELL_EVAL between enumsÆvar Arnfjörð Bjarmason, Sep 28, 2021
  3. 02/10 parse-options.[ch]: consistently use "enum parse_opt_flags"Ævar Arnfjörð Bjarmason, Sep 28, 2021
  4. Junio C HamanoSep 29, 2021
  5. Ævar Arnfjörð BjarmasonSep 29, 2021
  6. Junio C HamanoSep 29, 2021
  7. Junio C HamanoSep 29, 2021
  8. 03/10 parse-options.[ch]: consistently use "enum parse_opt_result"Ævar Arnfjörð Bjarmason, Sep 28, 2021
  9. Junio C HamanoSep 29, 2021
  10. 04/10 parse-options.c: use exhaustive "case" arms for "enum parse_opt_type"Ævar Arnfjörð Bjarmason, Sep 28, 2021
  11. Junio C HamanoSep 29, 2021
  12. Ævar Arnfjörð BjarmasonSep 29, 2021
  13. Junio C HamanoSep 29, 2021
  14. 05/10 parse-options.h: make the "flags" in "struct option" an enumÆvar Arnfjörð Bjarmason, Sep 28, 2021
  15. Junio C HamanoSep 29, 2021
  16. 07/10 commit-graph: stop using optname()Ævar Arnfjörð Bjarmason, Sep 28, 2021
  17. Taylor BlauSep 29, 2021
  18. Ævar Arnfjörð BjarmasonOct 1, 2021
  19. 06/10 parse-options.c: move optname() earlier in the fileÆvar Arnfjörð Bjarmason, Sep 28, 2021
  20. 08/10 parse-options.[ch]: make opt{bug,name}() "static"Ævar Arnfjörð Bjarmason, Sep 28, 2021
  21. 09/10 parse-options tests: test optname() outputÆvar Arnfjörð Bjarmason, Sep 28, 2021
  22. 10/10 parse-options: change OPT_{SHORT,UNSET} to an enumÆvar Arnfjörð Bjarmason, Sep 28, 2021
  23. Junio C HamanoSep 29, 2021
  24. 00/11 fix bug, use existing enumsÆvar Arnfjörð Bjarmason, Oct 1, 2021
  25. 01/11 parse-options.h: move PARSE_OPT_SHELL_EVAL between enumsÆvar Arnfjörð Bjarmason, Oct 1, 2021
  26. 02/11 parse-options.[ch]: consistently use "enum parse_opt_flags"Ævar Arnfjörð Bjarmason, Oct 1, 2021
  27. Junio C HamanoOct 1, 2021
  28. 03/11 parse-options.[ch]: consistently use "enum parse_opt_result"Ævar Arnfjörð Bjarmason, Oct 1, 2021
  29. 04/11 parse-options.c: use exhaustive "case" arms for "enum parse_opt_result"Ævar Arnfjörð Bjarmason, Oct 1, 2021
  30. 05/11 parse-options.c: use exhaustive "case" arms for "enum parse_opt_type"Ævar Arnfjörð Bjarmason, Oct 1, 2021
  31. 06/11 parse-options.h: make the "flags" in "struct option" an enumÆvar Arnfjörð Bjarmason, Oct 1, 2021
  32. 07/11 parse-options.c: move optname() earlier in the fileÆvar Arnfjörð Bjarmason, Oct 1, 2021
  33. 08/11 commit-graph: stop using optname()Ævar Arnfjörð Bjarmason, Oct 1, 2021
  34. René ScharfeOct 1, 2021
  35. 09/11 parse-options.[ch]: make opt{bug,name}() "static"Ævar Arnfjörð Bjarmason, Oct 1, 2021
  36. 10/11 parse-options tests: test optname() outputÆvar Arnfjörð Bjarmason, Oct 1, 2021
  37. 11/11 parse-options: change OPT_{SHORT,UNSET} to an enumÆvar Arnfjörð Bjarmason, Oct 1, 2021
  38. Junio C HamanoOct 1, 2021
  39. Junio C HamanoOct 1, 2021
  40. 00/10 fix bug, use more enumsÆvar Arnfjörð Bjarmason, Oct 8, 2021
  41. 01/10 parse-options.h: move PARSE_OPT_SHELL_EVAL between enumsÆvar Arnfjörð Bjarmason, Oct 8, 2021
  42. 03/10 parse-options.[ch]: consistently use "enum parse_opt_result"Ævar Arnfjörð Bjarmason, Oct 8, 2021
  43. SZEDER GáborNov 6, 2021
  44. Ævar Arnfjörð BjarmasonNov 6, 2021
  45. 0/2 parse-options.[ch]: enum fixup & enum nitÆvar Arnfjörð Bjarmason, Nov 9, 2021
  46. 1/2 parse-options.[ch]: revert use of "enum" for parse_options()Ævar Arnfjörð Bjarmason, Nov 9, 2021
  47. Junio C HamanoNov 9, 2021
  48. 2/2 parse-options.c: use "enum parse_opt_result" for parse_nodash_opt()Ævar Arnfjörð Bjarmason, Nov 9, 2021
  49. Junio C HamanoNov 9, 2021
  50. Ævar Arnfjörð BjarmasonNov 9, 2021
  51. Junio C HamanoNov 9, 2021
  52. parse-options.c: use "enum parse_opt_result" for parse_nodash_opt()Ævar Arnfjörð Bjarmason, Nov 10, 2021
  53. Junio C HamanoNov 11, 2021
  54. 02/10 parse-options.[ch]: consistently use "enum parse_opt_flags"Ævar Arnfjörð Bjarmason, Oct 8, 2021
  55. 05/10 parse-options.h: make the "flags" in "struct option" an enumÆvar Arnfjörð Bjarmason, Oct 8, 2021
  56. 04/10 parse-options.c: use exhaustive "case" arms for "enum parse_opt_result"Ævar Arnfjörð Bjarmason, Oct 8, 2021
  57. 06/10 parse-options.c: move optname() earlier in the fileÆvar Arnfjörð Bjarmason, Oct 8, 2021
  58. 07/10 commit-graph: stop using optname()Ævar Arnfjörð Bjarmason, Oct 8, 2021
  59. 08/10 parse-options.[ch]: make opt{bug,name}() "static"Ævar Arnfjörð Bjarmason, Oct 8, 2021
  60. 09/10 parse-options tests: test optname() outputÆvar Arnfjörð Bjarmason, Oct 8, 2021
  61. 10/10 parse-options: change OPT_{SHORT,UNSET} to an enumÆvar Arnfjörð Bjarmason, Oct 8, 2021

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.