Git development
 help / color / mirror / Atom feed
From: Junio C Hamano <junkio@cox.net>
To: Josef Weidendorfer <Josef.Weidendorfer@gmx.de>
Cc: git@vger.kernel.org
Subject: Re: Convention for help in git commands?
Date: Tue, 25 Oct 2005 11:56:34 -0700	[thread overview]
Message-ID: <7vfyqpe87x.fsf@assigned-by-dhcp.cox.net> (raw)
In-Reply-To: 200510251508.43552.Josef.Weidendorfer@gmx.de

Josef Weidendorfer <Josef.Weidendorfer@gmx.de> writes:

> * All git commands should react on command line option "-h"
> for help, dumping a few lines to stderr, prefixed by "usage:", giving
> the command usage without further descriptions. For the usage
> output, use the base name of the command, and not the absolute
> path to the binary.

It drives me nuts when an error message shows only basename not
full path and I find out that I was running a wrong executable
much later after wasting a lot of time trying to debug it.  But
I think "usage: " saying the basename only is user friendly and
a good convention.

> * For commands which need at least one argument, the usage
> is also printed, if the command is run without argument

This is slightly debatable.  I'd rather see it error out for one
thing, and we might want to do a sane default given no arguments
later.

> Perhaps these things should be done only for commands of the
> git lightwight porcelain?

Probably.

  reply	other threads:[~2005-10-25 18:56 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-10-25 13:08 Convention for help in git commands? Josef Weidendorfer
2005-10-25 18:56 ` Junio C Hamano [this message]
2005-10-25 20:24   ` Martin Langhoff
2005-10-25 21:35     ` Josef Weidendorfer
2005-10-25 22:07       ` Martin Langhoff

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

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

  git send-email \
    --in-reply-to=7vfyqpe87x.fsf@assigned-by-dhcp.cox.net \
    --to=junkio@cox.net \
    --cc=Josef.Weidendorfer@gmx.de \
    --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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox