git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "Santi Béjar" <sbejar@gmail.com>
Cc: Git Mailing List <git@vger.kernel.org>
Subject: Re: git help -t <topic>: list the help of the commands in a given topic
Date: Mon, 10 Dec 2007 17:07:14 -0800	[thread overview]
Message-ID: <7v7ijmjayl.fsf@gitster.siamese.dyndns.org> (raw)
In-Reply-To: 1197299021-28463-1-git-send-email-sbejar@gmail.com

Santi Béjar <sbejar@gmail.com> writes:

> With 'git help -t' lists the available topics.
>
> Show a hint to get a longer list when listing the common commands.

I like the idea of making the categorized command list in git(7)
available, and agree with you that renaming common_cmds[] to cmd_list[]
and place everything in there would be the way to go.

However, I doubt about your presentation.  Who are the intended
audience and what is the expected way this is used?

I highly suspect that it would be much easier to use if you add a mode
to "git help" that runs the pager over the categoized command list part
of git(7) manual page, without taking "show me list of topics" nor "show
commands only in this topic" parameters.  It is highly unlikely that a
user knows which category an obscure command whose name he wants to
recall is in, or can guess which category it would be classified in
after seeing the "category list".  It would be much more likely that he
finds it easier to scan (perhaps with "/<string>") the command list with
one line description in the pager.

  reply	other threads:[~2007-12-11  1:07 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-12-10 15:03 git help -t <topic>: list the help of the commands in a given topic Santi Béjar
2007-12-11  1:07 ` Junio C Hamano [this message]
2007-12-11  9:04   ` Santi Béjar

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=7v7ijmjayl.fsf@gitster.siamese.dyndns.org \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=sbejar@gmail.com \
    /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).