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

[PATCH v2 0/5] [RESEND with Cc:] Git help option to list user guides

From
Philip Oakley <philipoakley@iee.org>
Date
Mar 3, 2013, 23:44 UTC
Message-ID
<1362354260-3772-1-git-send-email-philipoakley@iee.org>

This is the much truncated (was 0/13] and updated series for noting that 'git help' can display the existing guides that are formatted as man pages, and providing a 'git help' option to list a few of the most useful guides.

The series is rebased on top of V1.8.2-rc1

Differences relative to V1 numbering Patch 1: Use 'Git' in help messages Dropped. a. the 'git version' string is used in the wild for version checking, in particular Git Gui checks the string is 'git version'. b. a recent patch series fixed on lower case messages for 'usage:', respect that. c. many consider that the 'git' reference was to the 'git <cmd>' format rather than (the system) Git's commands.

Patch 2 (now 1/5): Show 'git help <guide>' usage, with examples Correct elipsis dots for unterminated list of examples.

Patch 2 (now 2/5): Help.c use OPT_COUNTUP Unchanged.

Patch 4 (now 3/5): Help.c add --guide option Update commit message to explain the -g|--guide logic.

Patch 5 (now 4/5): Help.c: add list_common_guides_help() function Removed the 'build artefact' /* */ comment line. Note that these are just the common guides and used in a usage message. The data was generated by a script variant of generate-cmdlist.sh

Patch (new 5/5): Help doc: Include --guide option description Update the documentation/git-help.txt - I had been caught out by the same 'focus on the code' mistake made by many and forgot the documenation ;-)

Patch 6 - 13: All dropped. Drop the separate guide list.txt and extraction script, which was copied from the common command list and script. If the guide usage list is useful, extend the command-list.txt and generate-cmdlist.sh at a later date.

Drop the rename of user-manual and everyday because they are not formatted as manuals. They can't be started by help's call to 'man' (and possibly other paths) anyway.

Philip Oakley (5):
  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
  Help doc: Include --guide option description
 Documentation/git-help.txt | 28 +++++++++++++++++++++-------
 builtin/help.c             | 11 ++++++++---
 common-guides.h            | 11 +++++++++++
 git.c                      |  4 +++-
 help.c                     | 18 ++++++++++++++++++
 help.h                     |  1 +
 6 files changed, 62 insertions(+), 11 deletions(-)
 create mode 100644 common-guides.h
-- 
1.8.1.msysgit.1
Next: Philip Oakley
Message 1 of 6 in “[RESEND with Cc:] Git help option to list user guides”
  1. 0/5 [RESEND with Cc:] 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. 2/5 Help.c use OPT_COUNTUPPhilip Oakley, Mar 3, 2013
  4. 3/5 Help.c add --guide optionPhilip Oakley, Mar 3, 2013
  5. 4/5 Help.c: add list_common_guides_help() functionPhilip Oakley, Mar 3, 2013
  6. 5/5 Help doc: Include --guide option descriptionPhilip Oakley, Mar 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.