diff mbox series

[v2] git.c: show usage for accessing the git(1) help page

Message ID 20190515081112.12340-1-philipoakley@iee.org (mailing list archive)
State New, archived
Headers show
Series [v2] git.c: show usage for accessing the git(1) help page | expand

Commit Message

Philip Oakley May 15, 2019, 8:11 a.m. UTC
It is not immediately obvious how to use the `git help` system to show
the git(1) page, with its overview and its background and coordinating
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 | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Eric Sunshine May 15, 2019, 8:14 a.m. UTC | #1
On Wed, May 15, 2019 at 4:11 AM Philip Oakley <philipoakley@iee.org> wrote:
> It is not immediately obvious how to use the `git help` system to show
> the git(1) page, with its overview and its background and coordinating
> 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>
> ---
> diff --git a/git.c b/git.c
> @@ -33,7 +33,8 @@ 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.\n"
> +          "Use 'git help git' for an overview of the system.");

If you want to be consistent with the wording shown for "git help
<...>", you might want s/Use/See/.
diff mbox series

Patch

diff --git a/git.c b/git.c
index 2324ac0b7e..4797941dfd 100644
--- a/git.c
+++ b/git.c
@@ -33,7 +33,8 @@  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.\n"
+	   "Use 'git help git' for an overview of the system.");
 
 static int use_pager = -1;