All of lore.kernel.org
 help / color / mirror / Atom feed
From: Emily Shaffer <emilyshaffer@google.com>
To: Philip Oakley <philipoakley@iee.org>
Cc: Git List <git@vger.kernel.org>,
	Junio C Hamano <gitster@pobox.com>, Jeff King <peff@peff.net>,
	Johannes Schindelin <Johannes.Schindelin@gmx.de>,
	Duy Nguyen <pclouds@gmail.com>
Subject: Re: [PATCH] git.c: show usage for accessing the git(1) help page
Date: Tue, 14 May 2019 17:17:17 -0700	[thread overview]
Message-ID: <20190515001717.GA138048@google.com> (raw)
In-Reply-To: <20190514152450.15220-1-philipoakley@iee.org>

On Tue, May 14, 2019 at 04:24:50PM +0100, Philip Oakley wrote:
> It is not immediately obvious how to use the `git help` system
> to show the git(1) page, with all its background and ccordinating
> material, such as environment variables.
> 
> Let's simply list it as the last few words of the last usage line.
> 
> Signed-off-by: Philip Oakley <philipoakley@iee.org>
> ---
> This follows from the discussion <3cd065d1-9db5-f2e6-ddff-aa539746d45e@iee.org>
> ---
>  git.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/git.c b/git.c
> index 2324ac0b7e..9a852b09c1 100644
> --- a/git.c
> +++ b/git.c
> @@ -33,7 +33,7 @@ const char git_usage_string[] =
>  const char git_more_info_string[] =
>  	N_("'git help -a' and 'git help -g' list available subcommands and some\n"
>  	   "concept guides. See 'git help <command>' or 'git help <concept>'\n"
> -	   "to read about a specific subcommand or concept.");
> +	   "to read about a specific subcommand or concept. Or use 'git help git'.");

I'm not sure the wording makes sense here. It sounds like you're saying,
"Or use 'git help git' to read about specific subcommands or concepts."
which isn't really what I think you're trying to say.

What about, "Or, use 'git help git' for a detailed guide of the Git
system as a whole."

(I'm still not sure that's quite it - since `git help git` mostly
details the flags you can pass to git before invoking a subcommand. But
I'm not sure that `git --help` is the place to say that...)

>  
>  static int use_pager = -1;
>  
> -- 
> 2.21.0.windows.1.1517.gbad5f960a3.dirty
> 

  reply	other threads:[~2019-05-15  0:17 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-13 20:47 git --help not actually showing the git(1) help page Philip Oakley
2019-05-13 20:53 ` Jeff King
2019-05-13 21:55   ` Philip Oakley
2019-05-13 22:44     ` Junio C Hamano
2019-05-14 14:05       ` Philip Oakley
2019-05-14 15:24         ` [PATCH] git.c: show usage for accessing " Philip Oakley
2019-05-15  0:17           ` Emily Shaffer [this message]
2019-05-15  1:53             ` Jeff King
2019-05-15  6:43               ` Philip Oakley
2019-05-15  8:11                 ` [PATCH v2] " Philip Oakley
2019-05-15  8:14                   ` Eric Sunshine
2019-05-15 22:47                     ` [PATCH v3 0/2] " Philip Oakley
2019-05-15 22:47                       ` [PATCH v3 1/2] git.c: show usage for " Philip Oakley
2019-05-15 22:47                       ` [PATCH v3 2/2] Doc: git.txt: remove backticks from link and add git-scm.com/docs Philip Oakley
2019-05-16  1:56                         ` Junio C Hamano
2019-05-16 11:25                           ` Philip Oakley
2019-05-16 22:22                             ` Jeff King
2019-05-16 23:09                               ` Philip Oakley
2019-05-15  6:36             ` [PATCH] git.c: show usage for accessing the git(1) help page Philip Oakley

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=20190515001717.GA138048@google.com \
    --to=emilyshaffer@google.com \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=pclouds@gmail.com \
    --cc=peff@peff.net \
    --cc=philipoakley@iee.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.