@matheusbsbs / matheus-bagliano / commits / 0f6f195b77
Fork 0

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>

Christian Couder committed Dec 4, 2007 at 06:44 UTC 0f6f195b771eb09beda59bb29d3a1c46454085e8
4 files changed +53 -3
Documentation/git-help.txt new
+48
@@ -0,0 +1,48 @@
1 +git-help(1)
2 +======
3 +
4 +NAME
5 +----
6 +git-help - display help information about git
7 +
8 +SYNOPSIS
9 +--------
10 +'git help' [-a|--all] [COMMAND]
11 +
12 +DESCRIPTION
13 +-----------
14 +
15 +With no options and no COMMAND given, the synopsis of the 'git'
16 +command and a list of the most commonly used git commands are printed
17 +on the standard output.
18 +
19 +If the option '--all' or '-a' is given, then all available commands are
20 +printed on the standard output.
21 +
22 +If a git command is named, a manual page for that command is brought
23 +up. The 'man' program is used by default for this purpose.
24 +
25 +Note that 'git --help ...' is identical as 'git help ...' because the
26 +former is internally converted into the latter.
27 +
28 +OPTIONS
29 +-------
30 +-a|--all::
31 +
32 + Prints all the available commands on the standard output. This
33 + option superseeds any other option.
34 +
35 +Author
36 +------
37 +Written by Junio C Hamano <gitster@pobox.com> and the git-list
38 +<git@vger.kernel.org>.
39 +
40 +Documentation
41 +-------------
42 +Initial documentation was part of the gitlink:git[7] man page.
43 +Christian Couder <chriscool@tuxfamily.org> extracted and rewrote it a
44 +little. Maintenance is done by the git-list <git@vger.kernel.org>.
45 +
46 +GIT
47 +---
48 +Part of the gitlink:git[7] suite
Documentation/git.txt
+3 -3
@@ -101,9 +101,9 @@ OPTIONS
101
102 --help::
103 Prints the synopsis and a list of the most commonly used
104 - commands. If a git command is named this option will bring up
105 - the man-page for that command. If the option '--all' or '-a' is
106 - given then all available commands are printed.
104 + commands. If the option '--all' or '-a' is given then all
105 + available commands are printed. If a git command is named this
106 + option will bring up the manual page for that command.
107
108 --exec-path::
109 Path to wherever your core git programs are installed.
Makefile
+1
@@ -1158,6 +1158,7 @@ check-docs::
1158 case "$$how,$$cmd" in \
1159 *,git-citool | \
1160 *,git-gui | \
1161 + *,git-help | \
1162 documented,gitattributes | \
1163 documented,gitignore | \
1164 documented,gitmodules | \
command-list.txt
+1
@@ -46,6 +46,7 @@ git-get-tar-commit-id ancillaryinterrogators
46 git-grep mainporcelain common
47 git-gui mainporcelain
48 git-hash-object plumbingmanipulators
49 +git-help ancillaryinterrogators
50 git-http-fetch synchelpers
51 git-http-push synchelpers
52 git-imap-send foreignscminterface