git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Teemu Likonen <tlikonen@iki.fi>
To: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Cc: git@vger.kernel.org, gitster@pobox.com
Subject: [PATCH] Add subcommand "help" to the list of most commonly used subcommands
Date: Thu, 5 Jun 2008 11:19:11 +0300	[thread overview]
Message-ID: <20080605081911.GA5946@mithlond.arda.local> (raw)
In-Reply-To: <alpine.DEB.1.00.0806050747000.21190@racer>

Johannes Schindelin wrote (2008-06-05 07:48 +0100):

> A typical output would now look like this:
> 
> 	$ git reabse
> 	git: 'reabse' is not a git-command. See 'git --help'.

A side note: The following three commands seem to do exactly the same:

  $ git --help log
  $ git log --help
  $ git help log

Which in itself is good, I think, since in all the cases user expects to
get the manual for "log". It seems that "git help <command>" is the most
often advertised in manuals and tutorials but it does not show in the
list printed by "git / git --help / git help":

  $ git
  usage: [...]

  The most commonly used git commands are:
  [There's no "help" command in the list.]

I think it belongs there, so how about the following patch? There are
two logically separate changes but I didn't feel that they deserve
separate commits.

---snip---
Add subcommand "help" to the list of most commonly used subcommands

Commands "git", "git --help" and "git help" did not list the subcommand
"help" as one of the most commonly used git commands. Yet "git help" is
advertised as the help command of git so this patch adds "help" the
list.

In addition to that change the short description in git-help.txt manual
to start with a capital letter.

Signed-off-by: Teemu Likonen <tlikonen@iki.fi>
---
 Documentation/git-help.txt |    2 +-
 command-list.txt           |    2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index bfbba9e..4d3613c 100644
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -3,7 +3,7 @@ git-help(1)
 
 NAME
 ----
-git-help - display help information about git
+git-help - Display help information about git
 
 SYNOPSIS
 --------
diff --git a/command-list.txt b/command-list.txt
index 3583a33..510ac69 100644
--- a/command-list.txt
+++ b/command-list.txt
@@ -47,7 +47,7 @@ git-get-tar-commit-id                   ancillaryinterrogators
 git-grep                                mainporcelain common
 git-gui                                 mainporcelain
 git-hash-object                         plumbingmanipulators
-git-help				ancillaryinterrogators
+git-help				ancillaryinterrogators common
 git-http-fetch                          synchelpers
 git-http-push                           synchelpers
 git-imap-send                           foreignscminterface
-- 
1.5.6.rc1.15.gc0c85

  reply	other threads:[~2008-06-05  8:20 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-06-05  6:48 [TOY PATCH] git wrapper: show similar command names for an unknown command Johannes Schindelin
2008-06-05  8:19 ` Teemu Likonen [this message]
2008-06-05 10:32   ` [PATCH] Add subcommand "help" to the list of most commonly used subcommands Johannes Schindelin
2008-06-05 10:52     ` Teemu Likonen
2008-06-05 10:57       ` [PATCH v2 1/2] " Teemu Likonen
2008-06-05 10:57         ` [PATCH v2 2/2] More informative short description for git-help.txt Teemu Likonen
2008-06-05 12:58       ` [PATCH] Add subcommand "help" to the list of most commonly used subcommands Johannes Schindelin
2008-06-05 11:21     ` Sverre Rabbelier
2008-06-05 13:22       ` Teemu Likonen
2008-06-05 18:13   ` Junio C Hamano
2008-06-05 18:38     ` Pieter de Bie
2008-06-05 21:15       ` Teemu Likonen
2008-06-05 21:17       ` Junio C Hamano
2008-06-06  5:11         ` David Symonds
2008-06-05 18:42     ` Wincent Colaiuta
2008-06-05 19:15       ` Sverre Rabbelier
2008-06-05 20:59 ` [TOY PATCH] git wrapper: show similar command names for an unknown command Dirk Süsserott
2008-06-05 23:00   ` Johannes Schindelin
2008-06-06 12:15 ` Robin Rosenberg
2008-06-06 14:18   ` Wincent Colaiuta
2008-06-07  7:27 ` Alex Riesen
2008-06-07 15:04   ` Johannes Schindelin
2008-06-07 17:51     ` Alex Riesen
2008-06-07 18:08       ` Junio C Hamano
2008-06-08 15:07         ` Johannes Schindelin
2008-06-08 15:14           ` Dirk Süsserott
2008-06-08 17:53             ` Junio C Hamano
2008-06-08 23:26               ` Johannes Schindelin

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=20080605081911.GA5946@mithlond.arda.local \
    --to=tlikonen@iki.fi \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.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).