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

[PATCH 02/13] Show 'git help <guide>' usage, with examples

From
Philip Oakley <philipoakley@iee.org>
Date
Feb 23, 2013, 23:05 UTC
Message-ID
<1361660761-1932-3-git-send-email-philipoakley@iee.org>
In-Reply-To
<1361660761-1932-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..bf0e0de 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: David AguilarNext: W. Trevor King
Message 8 of 37 in “Git help option to list user guides”
  1. 00/13 Git help option to list user guidesPhilip Oakley, Feb 23, 2013
  2. 01/13 Use 'Git' in help messagesPhilip Oakley, Feb 23, 2013
  3. David AguilarFeb 23, 2013
  4. Philip OakleyFeb 23, 2013
  5. Junio C HamanoFeb 24, 2013
  6. Philip OakleyFeb 24, 2013
  7. David AguilarFeb 24, 2013
  8. 02/13 Show 'git help <guide>' usage, with examplesPhilip Oakley, Feb 23, 2013
  9. W. Trevor KingFeb 24, 2013
  10. Philip OakleyFeb 24, 2013
  11. 03/13 Help.c use OPT_COUNTUPPhilip Oakley, Feb 23, 2013
  12. 04/13 Help.c add --guide optionPhilip Oakley, Feb 23, 2013
  13. 05/13 Help.c: add list_common_guides_help() functionPhilip Oakley, Feb 23, 2013
  14. Junio C HamanoFeb 24, 2013
  15. Philip OakleyFeb 24, 2013
  16. Junio C HamanoFeb 25, 2013
  17. Philip OakleyFeb 25, 2013
  18. Junio C HamanoFeb 25, 2013
  19. 06/13 Add guide-list.txt and extraction shellPhilip Oakley, Feb 23, 2013
  20. W. Trevor KingFeb 24, 2013
  21. Philip OakleyFeb 24, 2013
  22. 07/13 Extend name string for longer namesPhilip Oakley, Feb 23, 2013
  23. 09/13 Rename everyday to giteverydayPhilip Oakley, Feb 23, 2013
  24. W. Trevor KingFeb 24, 2013
  25. Philip OakleyFeb 24, 2013
  26. 10/13 Update Git(1) links to guidesPhilip Oakley, Feb 23, 2013
  27. 11/13 Add missing guides to list and regeneratePhilip Oakley, Feb 23, 2013
  28. 12/13 Documentation/Makefile: update git guide linksPhilip Oakley, Feb 23, 2013
  29. W. Trevor KingFeb 24, 2013
  30. Philip OakleyFeb 24, 2013
  31. Junio C HamanoFeb 25, 2013
  32. Philip OakleyFeb 25, 2013
  33. Junio C HamanoFeb 26, 2013
  34. Philip OakleyFeb 26, 2013
  35. 13/13 Fixup! doc: giteveryday and user-manual man formatPhilip Oakley, Feb 23, 2013
  36. W. Trevor KingFeb 24, 2013
  37. Philip OakleyFeb 24, 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.