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

[PATCH 0/25] Usage message clean-up

From
freku045@student.liu.se <freku045@student.liu.se>
Date
Dec 10, 2005, 19:37 UTC
Message-ID
<1134243476675-git-send-email-freku045@student.liu.se>

This patch series is supposed to clean-up usage strings in *.sh and *.perl. I have gone through most of the scripts, but have left the following programs for various reasons.

No obvious fix:
  git-log.sh
  git-parse-remote.sh
  git-rebase.sh
Still todo:
  git-archimport.perl
  git-cvsexportcommit.perl
  git-cvsimport.perl
  git-svnimport.perl
  git-applymbox.sh
  git-applypatch.sh
  git-fmt-merge-msg.perl
  cmd-rename.sh
  git-ls-remote.sh
  git-merge-octopus.sh
  git-merge-one-file.sh
  git-merge-ours.sh
  git-merge-resolve.sh
  git-merge-stupid.sh
  git-octopus.sh
  git-parse-remote.sh
I have tried to follow the following rules:
* Any unrecognised options should make the script die with the usage
  message.
* -h and --help makes the script die with the usage message.
* The message is printed to stderr.
* The message is of the form "usage: $0 options"

I am not convinced that the last bullet point is the best way to do things. Using "$0" is probably best for Git developers but using "git program-name" is probably least confusing for users, especially if we are going to move the git-* binaries away from /usr/bin. Another option is "basename $0". What do you think?

--
 Documentation/git-revert.txt |    2 +
 git-bisect.sh                |    2 +
 git-branch.sh                |    2 +
 git-checkout.sh              |    2 +
 git-cherry.sh                |   18 ++++++++++--
 git-clone.sh                 |    2 +
 git-commit.sh                |    2 +
 git-count-objects.sh         |   11 +++++++
 git-fetch.sh                 |    8 +++++
 git-format-patch.sh          |    3 +-
 git-grep.sh                  |   11 ++++++-
 git-lost-found.sh            |   12 +++++++-
 git-merge.sh                 |    2 +
 git-mv.perl                  |   10 ++++++-
 git-prune.sh                 |    2 +
 git-pull.sh                  |    3 +-
 git-push.sh                  |    2 +
 git-relink.perl              |   10 +++----
 git-repack.sh                |    7 ++++-
 git-request-pull.sh          |    6 ++--
 git-reset.sh                 |    2 +
 git-revert.sh                |    4 +--
 git-send-email.perl          |   62 +++++++++++++++++++++++-------------------
 git-status.sh                |   12 +++++++-
 git-tag.sh                   |   10 +------
 git-verify-tag.sh            |   10 +++----
 26 files changed, 142 insertions(+), 75 deletions(-)
- Fredrik
Next: freku045@student.liu.se
Message 1 of 34 in “Usage message clean-up”
  1. 0/25 Usage message clean-upfreku045@student.liu.se, Dec 10, 2005
  2. 1/25 git-bisect: Use $0 instead of program name in usage message.freku045@student.liu.se, Dec 10, 2005
  3. 4/25 git-cherry: Print the usage message if we get an unknown option.freku045@student.liu.se, Dec 10, 2005
  4. 2/25 git-branch: Use $0 instead of program name in usage message.freku045@student.liu.se, Dec 10, 2005
  5. 3/25 git-checkout: Use $0 instead of program name in usage message.freku045@student.liu.se, Dec 10, 2005
  6. 9/25 git-format-patch: Use the 'die'-function where appropriate.freku045@student.liu.se, Dec 10, 2005
  7. 6/25 git-commit: Use $0 instead of program name in usage message.freku045@student.liu.se, Dec 10, 2005
  8. 5/25 git-clone: Use $0 instead of program name in usage message.freku045@student.liu.se, Dec 10, 2005
  9. 7/25 git-count-objects: Die with usage message if we are invoked incorrectly.freku045@student.liu.se, Dec 10, 2005
  10. Junio C HamanoDec 11, 2005
  11. 8/25 git-fetch: Print usage message if we get an unrecognized option.freku045@student.liu.se, Dec 10, 2005
  12. 10/25 git-grep: Print usage message on '-h' and '--help'.freku045@student.liu.se, Dec 10, 2005
  13. 16/25 git-push: Clean up usage messagefreku045@student.liu.se, Dec 10, 2005
  14. 15/25 git-pull: Don't print an extra new line at the end of the usage message.freku045@student.liu.se, Dec 10, 2005
  15. 13/25 git-merge: Print $0 instead of program name in usage message.freku045@student.liu.se, Dec 10, 2005
  16. 16/25 git-push: Clean-up usage messagefreku045@student.liu.se, Dec 10, 2005
  17. 14/25 git-prune: Print $0 instead of program name in usage message.freku045@student.liu.se, Dec 10, 2005
  18. 11/25 git-revert: Fix usage messagefreku045@student.liu.se, Dec 10, 2005
  19. 12/25 git-lost-found: Print usage message on incorrect invocation.freku045@student.liu.se, Dec 10, 2005
  20. 19/25 git-request-pull: Print usage message to stderr.freku045@student.liu.se, Dec 10, 2005
  21. 20/25 git-reset: Use $0 instead of program name in usage message.freku045@student.liu.se, Dec 10, 2005
  22. 17/25 git-relink: Print usage message to stderr.freku045@student.liu.se, Dec 10, 2005
  23. Junio C HamanoDec 11, 2005
  24. 18/25 git-repack: Print usage message on unrecognized option.freku045@student.liu.se, Dec 10, 2005
  25. 21/25 git-send-email: Usage message clean-up.freku045@student.liu.se, Dec 10, 2005
  26. Junio C HamanoDec 11, 2005
  27. 23/25 git-tag: Clean-up usage message.freku045@student.liu.se, Dec 10, 2005
  28. 22/25 git-status: Print usage message on incorrect invocation.freku045@student.liu.se, Dec 10, 2005
  29. 25/25 git-mv: Clean-up usage message.freku045@student.liu.se, Dec 10, 2005
  30. 24/25 git-verify-tag: Clean-up usage message.freku045@student.liu.se, Dec 10, 2005
  31. A Large Angry SCMDec 10, 2005
  32. Johannes SchindelinDec 10, 2005
  33. Junio C HamanoDec 11, 2005
  34. Nikolai WeibullDec 11, 2005

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.