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

[PATCH V3 0/5] Git help option to list user guides

From
Philip Oakley <philipoakley@iee.org>
Date
Apr 2, 2013, 22:39 UTC
Message-ID
<1364942392-576-1-git-send-email-philipoakley@iee.org>

This is the re-roll of $gmane/217384. The series seeks to provide a help option that will list the common git guides, and how to access them.

The series is rebased on top of V1.8.2 

Since V2, the OPT_BOOL is now used instead of OPT_COUNTUP. The git_more_info_string has been further updated inline with Junio's suggestions, and re-spaced so that command example are not split over line ends.

Junio's suggestions in $gmane/217354/focus=217355 have been included. Junio also asked about the `if (!argv[0])` test which is, correctly, performed _after_ the -a and -g options are taken, as they overide any remaining arguments.

The list of guides is spaced out in the same manner as the common command list.

Philip Oakley (5):
  Show help: -a and -g option, and 'git help <concept>' usage.
  Help.c use OPT_BOOL and refactor logic
  Help.c add --guide option
  Help.c: add list_common_guides_help() function
  Help doc: Include --guide option description
 Documentation/git-help.txt | 30 ++++++++++++++++++++++--------
 builtin/help.c             | 17 +++++++++++++++--
 common-guides.h            | 11 +++++++++++
 git.c                      |  4 +++-
 help.c                     | 18 ++++++++++++++++++
 help.h                     |  1 +
 6 files changed, 70 insertions(+), 11 deletions(-)
 create mode 100644 common-guides.h
-- 
1.8.1.msysgit.1
Next: Philip Oakley
Message 1 of 16 in “Git help option to list user guides”
  1. 0/5 Git help option to list user guidesPhilip Oakley, Apr 2, 2013
  2. 1/5 Show help: -a and -g option, and 'git help <concept>' usage.Philip Oakley, Apr 2, 2013
  3. Junio C HamanoApr 2, 2013
  4. 2/5 Help.c use OPT_BOOL and refactor logicPhilip Oakley, Apr 2, 2013
  5. Junio C HamanoApr 2, 2013
  6. Junio C HamanoApr 3, 2013
  7. Philip OakleyApr 3, 2013
  8. 3/5 Help.c add --guide optionPhilip Oakley, Apr 2, 2013
  9. 4/5 Help.c: add list_common_guides_help() functionPhilip Oakley, Apr 2, 2013
  10. Junio C HamanoApr 2, 2013
  11. Eric SunshineApr 3, 2013
  12. help: mark common_guides[] as translatableSimon Ruderich, Apr 12, 2013
  13. Philip OakleyApr 12, 2013
  14. 5/5 Help doc: Include --guide option descriptionPhilip Oakley, Apr 2, 2013
  15. Junio C HamanoApr 2, 2013
  16. Eric SunshineApr 3, 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.