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

[PATCH 00/13] Git help option to list user guides

From
Philip Oakley <philipoakley@iee.org>
Date
Feb 23, 2013, 23:05 UTC
Message-ID
<1361660761-1932-1-git-send-email-philipoakley@iee.org>

The git help system will list common commands, and all commands if asked. However it is difficult for newer users to discover the guides that are available. This series seeks to add such an option to 'git help', and allow the user-manual and [git]everyday to be accessed in the same way.

Patch 1 to 7 update the codebase and look to work correctly. Patch 1 & 3 are tidy ups. The code is very strongly based on the existing common-commands list so could be refactored and joined if the series is accepted.

Patch 8 onward get into areas of the documentation Makefile that I need help on so that the user-manual and [git]everyday can follow the naming convention for guides and be picked up by the code. The intent is shown, but the Documentation/Makefile fails for the renamed gituser-manual and giteveryday - advice needed.

I'm minded to make them have a man page format to simplify changes to the make file but haven't managed to get that format right. The alternative is to tweak the make file to cope with these 'pretty' documents yet still move them to their new names. (I'm unfamiliar with make files)

Holding pages have been created for the vacated page locations in the same vein as used for Rename {git- => git}remote-helpers.txt

The patches are built upon V1.8.2-rc0 which includes the recent user-manual changes.

Initial discussion was at $gmane/215814/focus=216146
Philip Oakley (13):
  Use 'Git' in help messages
  Show 'git help <guide>' usage, with examples
  Help.c use OPT_COUNTUP
  Help.c add --guide option
  Help.c: add list_common_guides_help() function
  Add guide-list.txt and extraction shell
  Extend name string for longer names
  Rename user-manual to gituser-manual
  Rename everyday to giteveryday
  Update Git(1) links to guides
  Add missing guides to list and regenerate
  Documentation/Makefile: update git guide links
  Fixup! doc: giteveryday and user-manual man format
 Documentation/Makefile           |    4 +
 Documentation/everyday.txt       |  424 +---
 Documentation/git.txt            |   12 +-
 Documentation/giteveryday.txt    |  419 ++++
 Documentation/gituser-manual.txt | 4639 +++++++++++++++++++++++++++++++++++++
 Documentation/user-manual.txt    | 4643 +-------------------------------------
 builtin/help.c                   |   11 +-
 common-guides.h                  |   15 +
 generate-cmdlist.sh              |    2 +-
 generate-guidelist.sh            |   23 +
 git.c                            |    4 +-
 guide-list.txt                   |   30 +
 help.c                           |   30 +-
 help.h                           |    1 +
 14 files changed, 5208 insertions(+), 5049 deletions(-)
 create mode 100644 Documentation/giteveryday.txt
 create mode 100644 Documentation/gituser-manual.txt
 create mode 100644 common-guides.h
 create mode 100644 generate-guidelist.sh
 create mode 100644 guide-list.txt
-- 
1.8.1.msysgit.1
Next: Philip Oakley
Message 1 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.