From: Philip Oakley <philipoakley@iee.org>
To: GitList <git@vger.kernel.org>
Subject: [PATCH 00/13] Git help option to list user guides
Date: Sat, 23 Feb 2013 23:05:48 +0000 [thread overview]
Message-ID: <1361660761-1932-1-git-send-email-philipoakley@iee.org> (raw)
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 reply other threads:[~2013-02-23 23:06 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-02-23 23:05 Philip Oakley [this message]
2013-02-23 23:05 ` [PATCH 01/13] Use 'Git' in help messages Philip Oakley
2013-02-23 23:41 ` David Aguilar
2013-02-23 23:54 ` Philip Oakley
2013-02-24 8:59 ` Junio C Hamano
2013-02-24 21:50 ` Philip Oakley
2013-02-24 22:11 ` David Aguilar
2013-02-23 23:05 ` [PATCH 02/13] Show 'git help <guide>' usage, with examples Philip Oakley
2013-02-24 14:39 ` W. Trevor King
2013-02-24 22:05 ` Philip Oakley
2013-02-23 23:05 ` [PATCH 03/13] Help.c use OPT_COUNTUP Philip Oakley
2013-02-23 23:05 ` [PATCH 04/13] Help.c add --guide option Philip Oakley
2013-02-23 23:05 ` [PATCH 05/13] Help.c: add list_common_guides_help() function Philip Oakley
2013-02-24 9:01 ` Junio C Hamano
2013-02-24 21:51 ` Philip Oakley
2013-02-25 5:24 ` Junio C Hamano
2013-02-25 23:43 ` Philip Oakley
2013-02-25 23:55 ` Junio C Hamano
2013-02-23 23:05 ` [PATCH 06/13] Add guide-list.txt and extraction shell Philip Oakley
2013-02-24 14:51 ` W. Trevor King
2013-02-24 22:12 ` Philip Oakley
2013-02-23 23:05 ` [PATCH 07/13] Extend name string for longer names Philip Oakley
2013-02-23 23:05 ` [PATCH 09/13] Rename everyday to giteveryday Philip Oakley
2013-02-24 14:55 ` W. Trevor King
2013-02-24 22:16 ` Philip Oakley
2013-02-23 23:05 ` [PATCH 10/13] Update Git(1) links to guides Philip Oakley
2013-02-23 23:05 ` [PATCH 11/13] Add missing guides to list and regenerate Philip Oakley
2013-02-23 23:06 ` [PATCH 12/13] Documentation/Makefile: update git guide links Philip Oakley
2013-02-24 14:58 ` W. Trevor King
2013-02-24 22:31 ` Philip Oakley
2013-02-25 5:29 ` Junio C Hamano
2013-02-25 23:43 ` Philip Oakley
2013-02-26 0:04 ` Junio C Hamano
2013-02-26 20:24 ` Philip Oakley
2013-02-23 23:06 ` [PATCH 13/13] Fixup! doc: giteveryday and user-manual man format Philip Oakley
2013-02-24 15:01 ` W. Trevor King
2013-02-24 22:32 ` 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=1361660761-1932-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).