@matheusbsbs / matheus-bagliano / commits / 45533d2694
Fork 0

Documentation: describe -i/--info option to "git-help"

Option -i|--info for "git-help" is documented only in the new "git-help.txt" man page, but this new man page is referenced from the "--help" option documentation in the "git.txt" man page. 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 45533d2694d480be86112f2da36d555e7373ba24
2 files changed +12 -2
Documentation/git-help.txt
+7 -2
@@ -7,7 +7,7 @@ git-help - display help information about git
7
8 SYNOPSIS
9 --------
10 -'git help' [-a|--all] [COMMAND]
10 +'git help' [-a|--all|-i|--info] [COMMAND]
11
12 DESCRIPTION
13 -----------
@@ -20,7 +20,8 @@ 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.
23 +up. The 'man' program is used by default for this purpose, but this
24 +can be overriden by other options.
25
26 Note that 'git --help ...' is identical as 'git help ...' because the
27 former is internally converted into the latter.
@@ -32,6 +33,10 @@ OPTIONS
33 Prints all the available commands on the standard output. This
34 option superseeds any other option.
35
36 +-i|--info::
37 + Use the 'info' program to display the manual page, instead of
38 + the 'man' program that is used by default.
39 +
40 Author
41 ------
42 Written by Junio C Hamano <gitster@pobox.com> and the git-list
Documentation/git.txt
+5
@@ -104,6 +104,11 @@ OPTIONS
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 +Other options are available to control how the manual page is
109 +displayed. See gitlink:git-help[1] for more information,
110 +because 'git --help ...' is converted internally into 'git
111 +help ...'.
112
113 --exec-path::
114 Path to wherever your core git programs are installed.