diff options
| author |  Christian Couder <chriscool@tuxfamily.org> | 2007-12-04 06:44:29 +0100 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2007-12-03 22:11:38 -0800 |
| commit | 0f6f195b771eb09beda59bb29d3a1c46454085e8 (patch) | |
| tree | 2ad1527943c6d9e202d218c47c796140ec8fbada | |
| parent | git-commit documentation: fix unfinished sentence. (diff) | |
| download | tgif-0f6f195b771eb09beda59bb29d3a1c46454085e8.tar.xz | |
Documentation: add a new man page for "git-help"
Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/git-help.txt | 48 | ||||
| -rw-r--r-- | Documentation/git.txt | 6 | ||||
| -rw-r--r-- | Makefile | 1 | ||||
| -rw-r--r-- | command-list.txt | 1 |
4 files changed, 53 insertions, 3 deletions
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt new file mode 100644 index 0000000000..a2255bc55a --- /dev/null +++ b/Documentation/git-help.txt @@ -0,0 +1,48 @@ +git-help(1) +====== + +NAME +---- +git-help - display help information about git + +SYNOPSIS +-------- +'git help' [-a|--all] [COMMAND] + +DESCRIPTION +----------- + +With no options and no COMMAND given, the synopsis of the 'git' +command and a list of the most commonly used git commands are printed +on the standard output. + +If the option '--all' or '-a' is given, then all available commands are +printed on the standard output. + +If a git command is named, a manual page for that command is brought +up. The 'man' program is used by default for this purpose. + +Note that 'git --help ...' is identical as 'git help ...' because the +former is internally converted into the latter. + +OPTIONS +------- +-a|--all:: + + Prints all the available commands on the standard output. This + option superseeds any other option. + +Author +------ +Written by Junio C Hamano <gitster@pobox.com> and the git-list +<git@vger.kernel.org>. + +Documentation +------------- +Initial documentation was part of the gitlink:git[7] man page. +Christian Couder <chriscool@tuxfamily.org> extracted and rewrote it a +little. Maintenance is done by the git-list <git@vger.kernel.org>. + +GIT +--- +Part of the gitlink:git[7] suite diff --git a/Documentation/git.txt b/Documentation/git.txt index 9ff4659d8c..c4e6fc6494 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -101,9 +101,9 @@ OPTIONS --help:: Prints the synopsis and a list of the most commonly used - commands. If a git command is named this option will bring up - the man-page for that command. If the option '--all' or '-a' is - given then all available commands are printed. + commands. If the option '--all' or '-a' is given then all + available commands are printed. If a git command is named this + option will bring up the manual page for that command. --exec-path:: Path to wherever your core git programs are installed. @@ -1158,6 +1158,7 @@ check-docs:: case "$$how,$$cmd" in \ *,git-citool | \ *,git-gui | \ + *,git-help | \ documented,gitattributes | \ documented,gitignore | \ documented,gitmodules | \ diff --git a/command-list.txt b/command-list.txt index d30e86965e..49506a411e 100644 --- a/command-list.txt +++ b/command-list.txt @@ -46,6 +46,7 @@ git-get-tar-commit-id ancillaryinterrogators git-grep mainporcelain common git-gui mainporcelain git-hash-object plumbingmanipulators +git-help ancillaryinterrogators git-http-fetch synchelpers git-http-push synchelpers git-imap-send foreignscminterface |