git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2 3/5] Help.c add --guide option

From
Philip Oakley <philipoakley@iee.org>
Date
Mar 3, 2013, 20:21 UTC
Message-ID
<1362342072-1412-4-git-send-email-philipoakley@iee.org>
In-Reply-To
<1362342072-1412-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 | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/builtin/help.c b/builtin/help.c
index d10cbed..6089d72 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_COUNTUP('a', "all", &show_all, N_("print all available commands")),
+	OPT_COUNTUP('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
 };
 
@@ -429,9 +431,11 @@ int cmd_help(int argc, const char **argv, const char *prefix)
 		printf(_("usage: %s%s"), _(git_usage_string), "\n\n");
 		list_commands(colopts, &main_cmds, &other_cmds);
 		printf("%s\n", _(git_more_info_string));
+		if (!show_guides) return 0;
+	}
+	if (show_guides) {
 		return 0;
 	}
-
 	if (!argv[0]) {
 		printf(_("usage: %s%s"), _(git_usage_string), "\n\n");
 		list_common_cmds_help();
-- 
1.8.1.msysgit.1
Previous: Philip OakleyNext: Junio C Hamano
Message 9 of 15 in “Git help option to list user guides”
  1. 0/5 Git help option to list user guidesPhilip Oakley, Mar 3, 2013
  2. 1/5 Show 'git help <guide>' usage, with examplesPhilip Oakley, Mar 3, 2013
  3. Junio C HamanoMar 3, 2013
  4. 2/5 Help.c use OPT_COUNTUPPhilip Oakley, Mar 3, 2013
  5. Junio C HamanoMar 3, 2013
  6. Philip OakleyMar 3, 2013
  7. Junio C HamanoMar 4, 2013
  8. Philip OakleyMar 4, 2013
  9. 3/5 Help.c add --guide optionPhilip Oakley, Mar 3, 2013
  10. Junio C HamanoMar 3, 2013
  11. Philip OakleyMar 3, 2013
  12. 4/5 Help.c: add list_common_guides_help() functionPhilip Oakley, Mar 3, 2013
  13. 5/5 Help doc: Include --guide option descriptionPhilip Oakley, Mar 3, 2013
  14. Junio C HamanoMar 3, 2013
  15. Philip OakleyMar 4, 2013

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.