git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Chris Webb <chris@arachsys.com>
To: git@vger.kernel.org
Subject: A handful of help-related patches
Date: Wed, 27 Jun 2012 21:54:59 +0100	[thread overview]
Message-ID: <20120627205459.GC11498@arachsys.com> (raw)

Whilst looking at git-rebase, I noticed I have a few local git --help
related patches from a couple of years ago that I use on my own systems.

I'm not sure whether they're just personal quirks, but I thought I should
post them to the list in case they're of wider interest or might be relevant
upstream.

The first two patches allow the HTML path used by git-help --web to be set
in .gitconfig, and allow it to be a URL prefix, so you can do

  [help]
    format = html
    htmlpath = http://git-scm.com/docs

git wibble --help will then open http://git-scm.com/docs/git-wibble.html
instead of /share/doc/git/html/git-wibble.html in your browser.

The third patch adds a help format called 'usage' making git wibble --help
equivalent to git wibble -h, i.e. printing short command-line usage
information. (Generally that's what I want and I end up rather surprised
when I get an unwanted man page because my fingers are trained to type the
more universal --help rather than -h.)

This 'usage' help format is also good for making --help do something useful
other than produce an error message on our cut-down servers without man
pages, web browsers and so on.

Best wishes,

Chris.

             reply	other threads:[~2012-06-27 20:55 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-06-27 20:54 Chris Webb [this message]
2012-06-27 20:55 ` [PATCH 1/3] Add config variable to set HTML path for git-help --web Chris Webb
2012-06-27 20:55   ` [PATCH 2/3] Allow help.htmlpath to be an http: URL Chris Webb
2012-06-27 21:05     ` Jeff King
2012-06-27 21:12       ` Chris Webb
2012-06-27 21:32       ` Junio C Hamano
2012-06-27 21:41         ` Chris Webb
2012-06-27 22:11         ` Jeff King
2012-06-27 22:19           ` Chris Webb
2012-06-27 22:52             ` Jeff King
2012-06-28  2:41               ` Junio C Hamano
2012-06-28  6:56               ` Chris Webb
2012-06-28 17:50                 ` Jeff King
2012-06-28 23:39                   ` Chris Webb
2012-06-27 20:55   ` [PATCH 3/3] Add a help format 'usage' to provide brief command usage Chris Webb

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=20120627205459.GC11498@arachsys.com \
    --to=chris@arachsys.com \
    --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;
as well as URLs for NNTP newsgroup(s).