git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Philip Oakley <philipoakley@iee.org>
To: GitList <git@vger.kernel.org>
Subject: [PATCH v2 0/5] Git help option to list user guides
Date: Sun,  3 Mar 2013 20:21:07 +0000	[thread overview]
Message-ID: <1362342072-1412-1-git-send-email-philipoakley@iee.org> (raw)

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

             reply	other threads:[~2013-03-03 20:21 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-03-03 20:21 Philip Oakley [this message]
2013-03-03 20:21 ` [PATCH v2 1/5] Show 'git help <guide>' usage, with examples Philip Oakley
2013-03-03 23:38   ` Junio C Hamano
2013-03-03 20:21 ` [PATCH v2 2/5] Help.c use OPT_COUNTUP Philip Oakley
2013-03-03 23:38   ` Junio C Hamano
2013-03-03 23:54     ` Philip Oakley
2013-03-04  0:05       ` Junio C Hamano
2013-03-04  0:31         ` Philip Oakley
2013-03-03 20:21 ` [PATCH v2 3/5] Help.c add --guide option Philip Oakley
2013-03-03 23:38   ` Junio C Hamano
2013-03-04  0:04     ` Philip Oakley
2013-03-03 20:21 ` [PATCH v2 4/5] Help.c: add list_common_guides_help() function Philip Oakley
2013-03-03 20:21 ` [PATCH v2 5/5] Help doc: Include --guide option description Philip Oakley
2013-03-03 23:39   ` Junio C Hamano
2013-03-04  0:18     ` Philip Oakley

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1362342072-1412-1-git-send-email-philipoakley@iee.org \
    --to=philipoakley@iee.org \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).