git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
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 3/5] Help.c add --guide option
Date: Tue,  2 Apr 2013 23:39:50 +0100	[thread overview]
Message-ID: <1364942392-576-4-git-send-email-philipoakley@iee.org> (raw)
In-Reply-To: <1364942392-576-1-git-send-email-philipoakley@iee.org>

Logic, but no actions, included.

The --all commands option, if given, will display first.
The --guide option's list will then be displayed.

The common commands list is only displayed if neither option,
nor a command or guide name, is given.

Signed-off-by: Philip Oakley <philipoakley@iee.org>
---
 builtin/help.c | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/builtin/help.c b/builtin/help.c
index 8969d3b..03d432b 100644
--- a/builtin/help.c
+++ b/builtin/help.c
@@ -36,10 +36,12 @@ enum help_format {
 static const char *html_path;
 
 static int show_all = 0;
+static int show_guides = 0;
 static unsigned int colopts;
 static enum help_format help_format = HELP_FORMAT_NONE;
 static struct option builtin_help_options[] = {
 	OPT_BOOL('a', "all", &show_all, N_("print all available commands")),
+	OPT_BOOL('g', "guides", &show_guides, N_("print list of useful guides")),
 	OPT_SET_INT('m', "man", &help_format, N_("show man page"), HELP_FORMAT_MAN),
 	OPT_SET_INT('w', "web", &help_format, N_("show manual in web browser"),
 			HELP_FORMAT_WEB),
@@ -49,7 +51,7 @@ static struct option builtin_help_options[] = {
 };
 
 static const char * const builtin_help_usage[] = {
-	N_("git help [--all] [--man|--web|--info] [command]"),
+	N_("git help [--all] [--guides] [--man|--web|--info] [command]"),
 	NULL
 };
 
@@ -430,7 +432,11 @@ int cmd_help(int argc, const char **argv, const char *prefix)
 		list_commands(colopts, &main_cmds, &other_cmds);
 	}
 
-	if (show_all) {
+	if (show_guides) {
+		/* do action - next patch */
+	}
+
+	if (show_all || show_guides) {
 		printf("%s\n", _(git_more_info_string));
 		/*
 		* We're done. Ignore any remaining args
-- 
1.8.1.msysgit.1

  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 ` Philip Oakley [this message]
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 ` [PATCH V3 5/5] Help doc: Include --guide option description Philip Oakley
2013-04-02 23:11   ` 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-4-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).