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

[PATCH v2 1/5] Show 'git help <guide>' usage, with examples

From
Philip Oakley <philipoakley@iee.org>
Date
Mar 3, 2013, 20:21 UTC
Message-ID
<1362342072-1412-2-git-send-email-philipoakley@iee.org>
In-Reply-To
<1362342072-1412-1-git-send-email-philipoakley@iee.org>

The git(1) man page must be accessed via 'git help git' on Git for Windows as it has no 'man' command. And it prompts users to read the git(1) page, rather than hoping they follow a subsidiary link within another documentation page. The 'tutorial' is an obvious guide to suggest.

Signed-off-by: Philip Oakley <philipoakley@iee.org>
---
 git.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/git.c b/git.c
index b10c18b..d9b71c1 100644
--- a/git.c
+++ b/git.c
@@ -13,7 +13,9 @@ const char git_usage_string[] =
 	"           <command> [<args>]";
 
 const char git_more_info_string[] =
-	N_("See 'git help <command>' for more information on a specific command.");
+	N_("See 'git help <command>' for more information on a specific command.\n"
+	   "While 'git help <guide>', will show the selected Git concept guide.\n"
+	   "Examples: 'git help git', 'git help branch', 'git help tutorial'...");
 
 static struct startup_info git_startup_info;
 static int use_pager = -1;
-- 
1.8.1.msysgit.1
Previous: Philip OakleyNext: Junio C Hamano
Message 2 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.