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@xxxxxxxxxxxxx> --- Documentation/git-help.txt | 53 ++++++++++++++++++++++++++++++++++++++++++++ Documentation/git.txt | 11 ++++++-- 2 files changed, 61 insertions(+), 3 deletions(-) create mode 100644 Documentation/git-help.txt This is a first documentation patch in my git-help improvement series. diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt new file mode 100644 index 0000000..232daae --- /dev/null +++ b/Documentation/git-help.txt @@ -0,0 +1,53 @@ +git-help(1) +====== + +NAME +---- +git-help - display help information about git + +SYNOPSIS +-------- +'git help' [-a|--all|-i|--info] [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, but this +can be overriden by other options. + +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. + +-i|--info:: + Use the 'info' program to display the manual page, instead of + the 'man' program that is used by default. + +Author +------ +Written by Junio C Hamano <gitster@xxxxxxxxx> and the git-list +<git@xxxxxxxxxxxxxxx>. + +Documentation +------------- +Initial documentation was part of the gitlink:git[7] man page. +Christian Couder <chriscool@xxxxxxxxxxxxx> extracted and rewrote it a +little. Maintenance is done by the git-list <git@xxxxxxxxxxxxxxx>. + +GIT +--- +Part of the gitlink:git[7] suite diff --git a/Documentation/git.txt b/Documentation/git.txt index 5460201..f8d1eef 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -100,9 +100,14 @@ 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. + + Other options are available to control how the manual page is + displayed. See gitlink:git-help[1] for more information, + because 'git --help ...' is converted internally into 'git + help ...'. --exec-path:: Path to wherever your core git programs are installed. -- 1.5.3.6.1993.g154f-dirty - 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
