git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Philip Oakley <philipoakley@iee.org>
To: GitList <git@vger.kernel.org>
Subject: [PATCH v2 5/5] Help doc: Include --guide option description
Date: Sun,  3 Mar 2013 20:21:12 +0000	[thread overview]
Message-ID: <1362342072-1412-6-git-send-email-philipoakley@iee.org> (raw)
In-Reply-To: <1362342072-1412-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 | 28 +++++++++++++++++++++-------
 1 file changed, 21 insertions(+), 7 deletions(-)

diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index e07b6dc..498a94e 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|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
 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 then, 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 Git subcommand, or a Git guide, is given, 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.
+
+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

  parent reply	other threads:[~2013-03-03 20:21 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-03-03 20:21 [PATCH v2 0/5] Git help option to list user guides Philip Oakley
2013-03-03 20:21 ` [PATCH v2 1/5] Show 'git help <guide>' usage, with examples Philip Oakley
2013-03-03 23:38   ` Junio C Hamano
2013-03-03 20:21 ` [PATCH v2 2/5] Help.c use OPT_COUNTUP Philip Oakley
2013-03-03 23:38   ` Junio C Hamano
2013-03-03 23:54     ` Philip Oakley
2013-03-04  0:05       ` Junio C Hamano
2013-03-04  0:31         ` Philip Oakley
2013-03-03 20:21 ` [PATCH v2 3/5] Help.c add --guide option Philip Oakley
2013-03-03 23:38   ` Junio C Hamano
2013-03-04  0:04     ` Philip Oakley
2013-03-03 20:21 ` [PATCH v2 4/5] Help.c: add list_common_guides_help() function Philip Oakley
2013-03-03 20:21 ` Philip Oakley [this message]
2013-03-03 23:39   ` [PATCH v2 5/5] Help doc: Include --guide option description Junio C Hamano
2013-03-04  0:18     ` Philip Oakley
  -- strict thread matches above, loose matches on Subject: below --
2013-03-03 23:44 [PATCH v2 0/5] [RESEND with Cc:] Git help option to list user guides Philip Oakley
2013-03-03 23:44 ` [PATCH v2 5/5] Help doc: Include --guide option description 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

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1362342072-1412-6-git-send-email-philipoakley@iee.org \
    --to=philipoakley@iee.org \
    --cc=git@vger.kernel.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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).