From: Philip Oakley <philipoakley@iee.org>
To: GitList <git@vger.kernel.org>
Cc: Junio C Hamano <gitster@pobox.com>,
"W. Trevor King" <wking@tremily.us>,
David Aguilar <davvid@gmail.com>
Subject: [PATCH V3 5/5] Help doc: Include --guide option description
Date: Tue, 2 Apr 2013 23:39:52 +0100 [thread overview]
Message-ID: <1364942392-576-6-git-send-email-philipoakley@iee.org> (raw)
In-Reply-To: <1364942392-576-1-git-send-email-philipoakley@iee.org>
Note that the ability to display an individual guide was
always possible. Include this in the update.
Also tell readers how git(1) can be accessed, especially for
Git for Windows users who do not have the 'man' command.
Likewise include a commentary on how to access this page (Catch 22).
Signed-off-by: Philip Oakley <philipoakley@iee.org>
---
Documentation/git-help.txt | 30 ++++++++++++++++++++++--------
1 file changed, 22 insertions(+), 8 deletions(-)
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index e07b6dc..442d941 100644
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -8,31 +8,45 @@ git-help - Display help information about Git
SYNOPSIS
--------
[verse]
-'git help' [-a|--all|-i|--info|-m|--man|-w|--web] [COMMAND]
+'git help' [-a|--all] [-g|--guide]
+ [-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE]
DESCRIPTION
-----------
-With no options and no COMMAND given, the synopsis of the 'git'
+With no options and no COMMAND or GUIDE given, the synopsis of the 'git'
command and a list of the most commonly used Git commands are printed
on the standard output.
-If the option '--all' or '-a' is given, then all available commands are
+If the option '--all' or '-a' is given, all available commands are
printed on the standard output.
-If a Git subcommand is named, a manual page for that subcommand is brought
-up. The 'man' program is used by default for this purpose, but this
-can be overridden by other options or configuration variables.
+If the option '--guide' or '-g' is given, a list of the useful
+Git guides is also printed on the standard output.
-Note that `git --help ...` is identical to `git help ...` because the
+If a command, or a guide, is given, a manual page for that command or
+guide is brought up. The 'man' program is used by default for this
+purpose, but this can be overridden by other options or configuration
+variables.
+
+Note that 'git --help ...' is identical to 'git help ...' because the
former is internally converted into the latter.
+To display the linkgit:git[1] man page, use 'git help git'.
+
+This page can be displayed with 'git help help' or 'git help --help'
+
OPTIONS
-------
-a::
--all::
Prints all the available commands on the standard output. This
- option supersedes any other option.
+ option overides any given command or guide name.
+
+-g::
+--guides::
+ Prints a list of useful guides on the standard output. This
+ option overides any given command or guide name.
-i::
--info::
--
1.8.1.msysgit.1
next prev parent reply other threads:[~2013-04-02 22:40 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-04-02 22:39 [PATCH V3 0/5] Git help option to list user guides Philip Oakley
2013-04-02 22:39 ` [PATCH V3 1/5] Show help: -a and -g option, and 'git help <concept>' usage Philip Oakley
2013-04-02 23:15 ` Junio C Hamano
2013-04-02 22:39 ` [PATCH V3 2/5] Help.c use OPT_BOOL and refactor logic Philip Oakley
2013-04-02 23:15 ` Junio C Hamano
2013-04-03 1:13 ` Junio C Hamano
2013-04-03 22:24 ` Philip Oakley
2013-04-02 22:39 ` [PATCH V3 3/5] Help.c add --guide option Philip Oakley
2013-04-02 22:39 ` [PATCH V3 4/5] Help.c: add list_common_guides_help() function Philip Oakley
2013-04-02 23:10 ` Junio C Hamano
2013-04-03 2:30 ` Eric Sunshine
2013-04-12 13:51 ` [PATCH] help: mark common_guides[] as translatable Simon Ruderich
2013-04-12 16:16 ` Philip Oakley
2013-04-02 22:39 ` Philip Oakley [this message]
2013-04-02 23:11 ` [PATCH V3 5/5] Help doc: Include --guide option description Junio C Hamano
2013-04-03 2:28 ` Eric Sunshine
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=1364942392-576-6-git-send-email-philipoakley@iee.org \
--to=philipoakley@iee.org \
--cc=davvid@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=wking@tremily.us \
/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).