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

Re: [PATCH 22/24] Let usage() take a printf-style format

From
Junio C Hamano <gitster@pobox.com>
Date
Nov 10, 2009, 20:16 UTC
Message-ID
<7veio66spc.fsf@alter.siamese.dyndns.org>
In-Reply-To
<1257779104-23884-22-git-send-email-jrnieder@gmail.com>
Jonathan Nieder <jrnieder@gmail.com> writes:
> merge-recursive and diff --no-index are not able to use usage()
> because their usage strings depend on the circumstances in which
> they are called.

Since die() and warn() are already printf-like, it may be tempting to do this, but this is wrong.

I do not want to vet all the existing call sites to usage() of make sure that all of them _happen_ to pass constant strings that do not have any '%' in them.

Much more importantly, without a patch to future-proof all existing callsites to modify from

	usage(blame_usage);
to
	usage("%s", blame_usage);

everybody needs to remember that some *_usage strings are special and have to double % in it forever, which is a maintenance nightmare.

Besides, the majority of usage strings are _expected_ to be constant. That is an important difference from die/warn whose purpose is to diagnose and give appropriate message to the situation (hence they benefit from formatting).

I've renamed this to usagef() and updated your two callers to use it in the version I queued to 'pu'.

Thanks.
Previous: Jonathan NiederNext: Jonathan Nieder
Message 37 of 39 in “Let 'git <command> -h' show usage without a git dir”
  1. Let 'git <command> -h' show usage without a git dirJonathan Nieder, Nov 8, 2009
  2. Show usage string for 'git http-push -h'Jonathan Nieder, Nov 8, 2009
  3. Tay Ray ChuanNov 9, 2009
  4. Show usage string for 'git http-push -h'Jonathan Nieder, Nov 9, 2009
  5. Tay Ray ChuanNov 9, 2009
  6. Junio C HamanoNov 8, 2009
  7. Jonathan NiederNov 8, 2009
  8. 00/24 Let 'git <command> -h' show usage without a git dirJonathan Nieder, Nov 9, 2009
  9. 01/24 Retire fetch--tool helper to contrib/examplesJonathan Nieder, Nov 9, 2009
  10. 02/24 Show usage string for 'git grep -h'Jonathan Nieder, Nov 9, 2009
  11. 03/24 Show usage string for 'git cherry -h'Jonathan Nieder, Nov 9, 2009
  12. 04/24 Show usage string for 'git commit-tree -h'Jonathan Nieder, Nov 9, 2009
  13. 05/24 Show usage string for 'git merge-ours -h'Jonathan Nieder, Nov 9, 2009
  14. 06/24 Show usage string for 'git show-ref -h'Jonathan Nieder, Nov 9, 2009
  15. 07/24 check-ref-format: update usage stringJonathan Nieder, Nov 9, 2009
  16. Junio C HamanoNov 10, 2009
  17. 08/24 Show usage string for 'git check-ref-format -h'Jonathan Nieder, Nov 9, 2009
  18. 09/24 Show usage string for 'git fast-import -h'Jonathan Nieder, Nov 9, 2009
  19. 10/24 Show usage string for 'git get-tar-commit-id -h'Jonathan Nieder, Nov 9, 2009
  20. 11/24 Show usage string for 'git imap-send -h'Jonathan Nieder, Nov 9, 2009
  21. 12/24 Show usage string for 'git mailsplit -h'Jonathan Nieder, Nov 9, 2009
  22. 13/24 Show usage string for 'git merge-one-file -h'Jonathan Nieder, Nov 9, 2009
  23. 14/24 Show usage string for 'git rev-parse -h'Jonathan Nieder, Nov 9, 2009
  24. 15/24 Show usage string for 'git show-index -h'Jonathan Nieder, Nov 9, 2009
  25. 16/24 Show usage string for 'git unpack-file -h'Jonathan Nieder, Nov 9, 2009
  26. 17/24 Show usage string for 'git stripspace -h'Jonathan Nieder, Nov 9, 2009
  27. 18/24 merge: do not setup worktree twiceJonathan Nieder, Nov 9, 2009
  28. Junio C HamanoNov 10, 2009
  29. Jonathan NiederNov 11, 2009
  30. 19/24 Let 'git http-fetch -h' show usage outside any git repositoryJonathan Nieder, Nov 9, 2009
  31. 20/24 http-fetch: add missing initialization of argv0_pathJonathan Nieder, Nov 9, 2009
  32. Junio C HamanoNov 10, 2009
  33. Johannes SixtNov 10, 2009
  34. Jonathan NiederNov 11, 2009
  35. 21/24 Let 'git <command> -h' show usage without a git dirJonathan Nieder, Nov 9, 2009
  36. 22/24 Let usage() take a printf-style formatJonathan Nieder, Nov 9, 2009
  37. Junio C HamanoNov 10, 2009
  38. 23/24 merge-{recursive,subtree}: use usage() to print usageJonathan Nieder, Nov 9, 2009
  39. 24/24 diff --no-index: make the usage string less scaryJonathan Nieder, Nov 9, 2009

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.