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

Re: [PATCH v2 00/13] Fixes to trailer test script, help text, and documentation

From
Junio C Hamano <gitster@pobox.com>
Date
Aug 11, 2023, 01:41 UTC
Message-ID
<xmqq7cq2pd7o.fsf@gitster.g>
In-Reply-To
<pull.1564.v2.git.1691702283.gitgitgadget@gmail.com>

t0450 dies like the attached, probably because the documentation was updated to say "<key> or <keyAlias>" but a matching update to the output of "interpret-trailers -h" command help is missing?

A possible trivial fix to 13/13 will be queued on top as "SQUASH???" patch for now.

 builtin/interpret-trailers.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git c/builtin/interpret-trailers.c w/builtin/interpret-trailers.c
index 832f86a770..d2d78fd961 100644
--- c/builtin/interpret-trailers.c
+++ w/builtin/interpret-trailers.c
@@ -14,7 +14,7 @@
 
 static const char * const git_interpret_trailers_usage[] = {
 	N_("git interpret-trailers [--in-place] [--trim-empty]\n"
-	   "                       [(--trailer <token>[(=|:)<value>])...]\n"
+	   "                       [(--trailer (<key>|<keyAlias>)[(=|:)<value>])...]\n"
 	   "                       [--parse] [<file>...]"),
 	NULL
 };





--- txt 2023-08-10 22:31:54.328609532 +0000
+++ help        2023-08-10 22:31:54.332609929 +0000
@@ -1,3 +1,3 @@
 git interpret-trailers [--in-place] [--trim-empty]
-                       [(--trailer (<key>|<keyAlias>)[(=|:)<value>])...]
+                       [(--trailer <token>[(=|:)<value>])...]
                        [--parse] [<file>...]
not ok 302 - interpret-trailers -h output and SYNOPSIS agree
#
#                       t2s="$(txt_to_synopsis "$builtin")" &&
#                       if test "$builtin" = "merge-tree"
#                       then
#                               test_when_finished "rm -f t2s.new" &&
#                               sed -e 's/ (deprecated)$//g' <"$t2s" >t2s.new
#                               t2s=t2s.new
#                       fi &&
#                       h2s="$(help_to_synopsis "$builtin")" &&
#
#                       # The *.txt and -h use different spacing for the
#                       # alignment of continued usage output, normalize it.
#                       align_after_nl "$builtin" <"$t2s" >txt &&
#                       align_after_nl "$builtin" <"$h2s" >help &&
#                       test_cmp txt help
#
1
Previous: Linus Arver via GitGitGadgetNext: Linus Arver
Message 27 of 52 in “Fixes to trailer test script, help text, and documentation”
  1. 0/5 Fixes to trailer test script, help text, and documentationLinus Arver via GitGitGadget, Aug 5, 2023
  2. 2/5 trailer test description: this tests --where=after, not --where=beforeLinus Arver via GitGitGadget, Aug 5, 2023
  3. 5/5 trailer --no-divider help: describe usual "---" meaningLinus Arver via GitGitGadget, Aug 5, 2023
  4. 1/5 trailer tests: make test cases self-containedLinus Arver via GitGitGadget, Aug 5, 2023
  5. Linus ArverAug 7, 2023
  6. 4/5 trailer: trailer location is a place, not an actionLinus Arver via GitGitGadget, Aug 5, 2023
  7. 3/5 trailer: add tests to check defaulting behavior with --no-* flagsLinus Arver via GitGitGadget, Aug 5, 2023
  8. Junio C HamanoAug 7, 2023
  9. Linus ArverAug 7, 2023
  10. Linus ArverAug 7, 2023
  11. Linus ArverAug 7, 2023
  12. Junio C HamanoAug 7, 2023
  13. 00/13 Fixes to trailer test script, help text, and documentationLinus Arver via GitGitGadget, Aug 10, 2023
  14. 02/13 trailer test description: this tests --where=after, not --where=beforeLinus Arver via GitGitGadget, Aug 10, 2023
  15. 01/13 trailer tests: make test cases self-containedLinus Arver via GitGitGadget, Aug 10, 2023
  16. 04/13 trailer doc: narrow down scope of --where and related flagsLinus Arver via GitGitGadget, Aug 10, 2023
  17. 03/13 trailer: add tests to check defaulting behavior with --no-* flagsLinus Arver via GitGitGadget, Aug 10, 2023
  18. 05/13 trailer: trailer location is a place, not an actionLinus Arver via GitGitGadget, Aug 10, 2023
  19. 06/13 trailer --no-divider help: describe usual "---" meaningLinus Arver via GitGitGadget, Aug 10, 2023
  20. 07/13 trailer --parse help: expose aliased optionsLinus Arver via GitGitGadget, Aug 10, 2023
  21. 09/13 trailer --parse docs: add explanation for its usefulnessLinus Arver via GitGitGadget, Aug 10, 2023
  22. 10/13 trailer --unfold help: prefer "reformat" over "join"Linus Arver via GitGitGadget, Aug 10, 2023
  23. 08/13 trailer --only-input: prefer "configuration variables" over "rules"Linus Arver via GitGitGadget, Aug 10, 2023
  24. 11/13 trailer doc: emphasize the effect of configuration variablesLinus Arver via GitGitGadget, Aug 10, 2023
  25. 12/13 trailer doc: separator within key suppresses default separatorLinus Arver via GitGitGadget, Aug 10, 2023
  26. 13/13 trailer doc: <token> is a <key> or <keyAlias>, not bothLinus Arver via GitGitGadget, Aug 10, 2023
  27. Junio C HamanoAug 11, 2023
  28. Linus ArverAug 11, 2023
  29. 00/13 Fixes to trailer test script, help text, and documentationLinus Arver via GitGitGadget, Sep 7, 2023
  30. 02/13 trailer test description: this tests --where=after, not --where=beforeLinus Arver via GitGitGadget, Sep 7, 2023
  31. 03/13 trailer: add tests to check defaulting behavior with --no-* flagsLinus Arver via GitGitGadget, Sep 7, 2023
  32. Junio C HamanoSep 8, 2023
  33. 01/13 trailer tests: make test cases self-containedLinus Arver via GitGitGadget, Sep 7, 2023
  34. 04/13 trailer doc: narrow down scope of --where and related flagsLinus Arver via GitGitGadget, Sep 7, 2023
  35. 06/13 trailer --no-divider help: describe usual "---" meaningLinus Arver via GitGitGadget, Sep 7, 2023
  36. Junio C HamanoSep 8, 2023
  37. 05/13 trailer: trailer location is a place, not an actionLinus Arver via GitGitGadget, Sep 7, 2023
  38. Jonathan TanSep 19, 2023
  39. 08/13 trailer --only-input: prefer "configuration variables" over "rules"Linus Arver via GitGitGadget, Sep 7, 2023
  40. 10/13 trailer --unfold help: prefer "reformat" over "join"Linus Arver via GitGitGadget, Sep 7, 2023
  41. 09/13 trailer --parse docs: add explanation for its usefulnessLinus Arver via GitGitGadget, Sep 7, 2023
  42. Junio C HamanoSep 8, 2023
  43. 07/13 trailer --parse help: expose aliased optionsLinus Arver via GitGitGadget, Sep 7, 2023
  44. Jonathan TanSep 19, 2023
  45. 12/13 trailer doc: separator within key suppresses default separatorLinus Arver via GitGitGadget, Sep 7, 2023
  46. 11/13 trailer doc: emphasize the effect of configuration variablesLinus Arver via GitGitGadget, Sep 7, 2023
  47. 13/13 trailer doc: <token> is a <key> or <keyAlias>, not bothLinus Arver via GitGitGadget, Sep 7, 2023
  48. Jonathan TanSep 19, 2023
  49. Linus ArverSep 20, 2023
  50. Junio C HamanoSep 20, 2023
  51. Linus ArverSep 22, 2023
  52. 13/13 trailer doc: <token> is a <key> or <keyAlias>, not bothTeng Long, Nov 10, 2023

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.