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

[PATCH 5/6] shortlog: correct option help for -w

From
René Scharfe <l.s.r@web.de>
Date
Aug 2, 2018, 19:18 UTC
Message-ID
<4e96d2a2-dfdc-3f6f-e2c7-2eb954ed633c@web.de>
In-Reply-To
<ad2d8f99-07a3-0191-88a2-c43081657988@web.de>

Wrap the placeholders in the option help string for -w in pairs of angular brackets to document that users need to replace them with actual numbers. Use the flag PARSE_OPT_LITERAL_ARGHELP to prevent parseopt from adding another pair.

Signed-off-by: Rene Scharfe <l.s.r@web.de>
---
 builtin/shortlog.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/builtin/shortlog.c b/builtin/shortlog.c
index 608d6ba77b..f555cf9e4f 100644
--- a/builtin/shortlog.c
+++ b/builtin/shortlog.c
@@ -268,8 +268,10 @@ int cmd_shortlog(int argc, const char **argv, const char *prefix)
 			 N_("Suppress commit descriptions, only provides commit count")),
 		OPT_BOOL('e', "email", &log.email,
 			 N_("Show the email address of each author")),
-		{ OPTION_CALLBACK, 'w', NULL, &log, N_("w[,i1[,i2]]"),
-			N_("Linewrap output"), PARSE_OPT_OPTARG, &parse_wrap_args },
+		{ OPTION_CALLBACK, 'w', NULL, &log, N_("<w>[,<i1>[,<i2>]]"),
+			N_("Linewrap output"),
+			PARSE_OPT_OPTARG | PARSE_OPT_LITERAL_ARGHELP,
+			&parse_wrap_args },
 		OPT_END(),
 	};
 
-- 
2.18.0
Previous: René ScharfeNext: René Scharfe
Message 23 of 38 in “push: comment on a funny unbalanced option help”
  1. push: comment on a funny unbalanced option helpJunio C Hamano, Aug 1, 2018
  2. Ævar Arnfjörð BjarmasonAug 1, 2018
  3. Junio C HamanoAug 1, 2018
  4. Ævar Arnfjörð BjarmasonAug 1, 2018
  5. René ScharfeAug 2, 2018
  6. Ævar Arnfjörð BjarmasonAug 2, 2018
  7. René ScharfeAug 2, 2018
  8. René ScharfeAug 2, 2018
  9. Junio C HamanoAug 2, 2018
  10. Junio C HamanoAug 2, 2018
  11. René ScharfeAug 2, 2018
  12. Jeff KingAug 2, 2018
  13. René ScharfeAug 2, 2018
  14. 1/6 add, update-index: fix --chmod argument helpRené Scharfe, Aug 2, 2018
  15. Ævar Arnfjörð BjarmasonAug 2, 2018
  16. Ramsay JonesAug 2, 2018
  17. Junio C HamanoAug 2, 2018
  18. Andrei RybakAug 2, 2018
  19. Junio C HamanoAug 2, 2018
  20. 2/6 difftool: remove angular brackets from argument helpRené Scharfe, Aug 2, 2018
  21. 3/6 pack-objects: specify --index-version argument help explicitlyRené Scharfe, Aug 2, 2018
  22. 4/6 send-pack: specify --force-with-lease argument help explicitlyRené Scharfe, Aug 2, 2018
  23. 5/6 shortlog: correct option help for -wRené Scharfe, Aug 2, 2018
  24. 6/6 parse-options: automatically infer PARSE_OPT_LITERAL_ARGHELPRené Scharfe, Aug 2, 2018
  25. Junio C HamanoAug 2, 2018
  26. Kerry, RichardAug 3, 2018
  27. Kerry, RichardAug 3, 2018
  28. Junio C HamanoAug 2, 2018
  29. René ScharfeAug 2, 2018
  30. Junio C HamanoAug 3, 2018
  31. Re* [PATCH] push: comment on a funny unbalanced option helpJunio C Hamano, Aug 2, 2018
  32. René ScharfeAug 2, 2018
  33. Junio C HamanoAug 2, 2018
  34. Ævar Arnfjörð BjarmasonAug 2, 2018
  35. Junio C HamanoAug 2, 2018
  36. René ScharfeAug 3, 2018
  37. Junio C HamanoAug 3, 2018
  38. Jonathan NiederAug 1, 2018

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.