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
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html