git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: freku045@student.liu.se
To: git@vger.kernel.org
Cc: freku045@student.liu.se
Subject: [PATCH 0/25] Usage message clean-up
Date: Sat, 10 Dec 2005 20:37:56 +0100	[thread overview]
Message-ID: <1134243476675-git-send-email-freku045@student.liu.se> (raw)
In-Reply-To: 

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

             reply	other threads:[~2005-12-10 19:38 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-12-10 19:37 freku045 [this message]
2005-12-10 19:37 ` [PATCH 1/25] git-bisect: Use $0 instead of program name in usage message freku045
2005-12-10 19:37 ` [PATCH 5/25] git-clone: " freku045
2005-12-10 19:37 ` [PATCH 4/25] git-cherry: Print the usage message if we get an unknown option freku045
2005-12-10 19:37 ` [PATCH 8/25] git-fetch: Print usage message if we get an unrecognized option freku045
2005-12-10 19:37 ` [PATCH 3/25] git-checkout: Use $0 instead of program name in usage message freku045
2005-12-10 19:37 ` [PATCH 7/25] git-count-objects: Die with usage message if we are invoked incorrectly freku045
2005-12-11  4:22   ` Junio C Hamano
2005-12-10 19:37 ` [PATCH 9/25] git-format-patch: Use the 'die'-function where appropriate freku045
2005-12-10 19:37 ` [PATCH 2/25] git-branch: Use $0 instead of program name in usage message freku045
2005-12-10 19:37 ` [PATCH 6/25] git-commit: " freku045
2005-12-10 19:37 ` [PATCH 16/25] git-push: Clean up " freku045
2005-12-10 19:37 ` [PATCH 14/25] git-prune: Print $0 instead of program name in " freku045
2005-12-10 19:37 ` [PATCH 16/25] git-push: Clean-up " freku045
2005-12-10 19:37 ` [PATCH 12/25] git-lost-found: Print usage message on incorrect invocation freku045
2005-12-10 19:37 ` [PATCH 11/25] git-revert: Fix usage message freku045
2005-12-10 19:37 ` [PATCH 10/25] git-grep: Print usage message on '-h' and '--help' freku045
2005-12-10 19:37 ` [PATCH 13/25] git-merge: Print $0 instead of program name in usage message freku045
2005-12-10 19:37 ` [PATCH 15/25] git-pull: Don't print an extra new line at the end of the " freku045
2005-12-10 19:37 ` [PATCH 18/25] git-repack: Print usage message on unrecognized option freku045
2005-12-10 19:37 ` [PATCH 21/25] git-send-email: Usage message clean-up freku045
2005-12-11  4:30   ` Junio C Hamano
2005-12-10 19:37 ` [PATCH 19/25] git-request-pull: Print usage message to stderr freku045
2005-12-10 19:37 ` [PATCH 22/25] git-status: Print usage message on incorrect invocation freku045
2005-12-10 19:37 ` [PATCH 17/25] git-relink: Print usage message to stderr freku045
2005-12-11  4:26   ` Junio C Hamano
2005-12-10 19:37 ` [PATCH 20/25] git-reset: Use $0 instead of program name in usage message freku045
2005-12-10 19:37 ` [PATCH 23/25] git-tag: Clean-up " freku045
2005-12-10 19:38 ` [PATCH 24/25] git-verify-tag: " freku045
2005-12-10 19:38 ` [PATCH 25/25] git-mv: " freku045
2005-12-10 22:13 ` [PATCH 0/25] Usage message clean-up A Large Angry SCM
2005-12-10 22:50 ` Johannes Schindelin
2005-12-11  2:58   ` Junio C Hamano
2005-12-11 11:16 ` Nikolai Weibull

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1134243476675-git-send-email-freku045@student.liu.se \
    --to=freku045@student.liu.se \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).