# [PATCH] Documentation: add a new man page for "git-help" and -i|--info option. 7 messages from 2007-12-04 to 2007-12-05. Participants: Christian Couder, Junio C Hamano, Väinö Järvelä, Wincent Colaiuta. Thread: https://gitlist.dev/t/11126 ## Christian Couder, 2007-12-04 05:44 Subject: [PATCH] Documentation: add a new man page for "git-help" and -i|--info option. Message-ID: <20071204064429.1b5007b2.chriscool@tuxfamily.org> URL: https://gitlist.dev/e/20071204064429.1b5007b2.chriscool%40tuxfamily.org ``` 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 --- 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 and the git-list +. + +Documentation +------------- +Initial documentation was part of the gitlink:git[7] man page. +Christian Couder extracted and rewrote it a +little. Maintenance is done by the git-list . + +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 ``` ## Junio C Hamano, 2007-12-04 08:43 Subject: Re: [PATCH] Documentation: add a new man page for "git-help" and -i|--info option. Message-ID: <7v4pey7suv.fsf@gitster.siamese.dyndns.org> URL: https://gitlist.dev/e/7v4pey7suv.fsf%40gitster.siamese.dyndns.org In-Reply-To: <20071204064429.1b5007b2.chriscool@tuxfamily.org> ``` Christian Couder writes: > 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 I like the addition of git-help manpage, but this ties the new manual page to inclusion of your "git help -i" series. For now, I'd strip the description of -i and apply the remainder. Let's cook -i / -w / -x enhancement idea a bit more on the list before going ahead with it. ``` ## Väinö Järvelä, 2007-12-05 08:19 Subject: Re: [PATCH] Documentation: add a new man page for "git-help" and -i|--info option. Message-ID: <178B37CE-9B28-4CE2-B8A0-FCA28CF85E12@pp.inet.fi> URL: https://gitlist.dev/e/178B37CE-9B28-4CE2-B8A0-FCA28CF85E12%40pp.inet.fi In-Reply-To: <20071204064429.1b5007b2.chriscool@tuxfamily.org> ``` Patch attached to fix header error in this patch. (Attached because Mail.app mangles inline patches) -- Väinö On Dec 4, 2007, at 07:44, Christian Couder wrote: > 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 > --- > 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 and the git-list > +. > + > +Documentation > +------------- > +Initial documentation was part of the gitlink:git[7] man page. > +Christian Couder extracted and rewrote it a > +little. Maintenance is done by the git-list . > + > +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@vger.kernel.org > More majordomo info at http://vger.kernel.org/majordomo-info.html From 6d9fa82be1074a9fe6bf3fad36a838c1142966ca Mon Sep 17 00:00:00 2001 From: =?utf-8?q?V=C3=A4in=C3=B6=20J=C3=A4rvel=C3=A4?= Date: Wed, 5 Dec 2007 10:05:48 +0200 Subject: [PATCH] Fixed git-help.txt header error MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Signed-off-by: Väinö Järvelä --- Documentation/git-help.txt | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 232daae..c94e27b 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -1,5 +1,5 @@ git-help(1) -====== +=========== NAME ---- -- 1.5.3.7.2115.geb80 ``` ## Wincent Colaiuta, 2007-12-05 08:27 Subject: Re: [PATCH] Documentation: add a new man page for "git-help" and -i|--info option. Message-ID: URL: https://gitlist.dev/e/B4734D40-9EE8-4B96-9426-FF5974F8488E%40wincent.com In-Reply-To: <178B37CE-9B28-4CE2-B8A0-FCA28CF85E12@pp.inet.fi> ``` El 5/12/2007, a las 9:19, Väinö Järvelä escribió: > Patch attached to fix header error in this patch. > > (Attached because Mail.app mangles inline patches) I'm a Mail.app user as well. Any reason why you can't use "git send- email"? It's very useful. Cheers, Wincent ``` ## Väinö Järvelä, 2007-12-05 08:33 Subject: Re: [PATCH] Documentation: add a new man page for "git-help" and -i|--info option. Message-ID: URL: https://gitlist.dev/e/E6D70DFA-79C6-4B97-B749-DEE11F2B2B47%40pp.inet.fi In-Reply-To: ``` On Dec 5, 2007, at 10:27, Wincent Colaiuta wrote: > El 5/12/2007, a las 9:19, Väinö Järvelä escribió: > >> Patch attached to fix header error in this patch. >> >> (Attached because Mail.app mangles inline patches) > > I'm a Mail.app user as well. Any reason why you can't use "git send- > email"? It's very useful. I didn't remember that send-email had "--in-reply-to" parameter, and I thought it would be cleaner to send as a reply. Thus I used Mail.app. -- Väinö ``` ## Junio C Hamano, 2007-12-05 08:58 Subject: Re: [PATCH] Documentation: add a new man page for "git-help" and -i|--info option. Message-ID: <7vabopzfek.fsf@gitster.siamese.dyndns.org> URL: https://gitlist.dev/e/7vabopzfek.fsf%40gitster.siamese.dyndns.org In-Reply-To: <178B37CE-9B28-4CE2-B8A0-FCA28CF85E12@pp.inet.fi> ``` Perhaps your mail and my push crossed. The same fix is there at the tip of 'master' branch since last night. ``` ## Väinö Järvelä, 2007-12-05 11:50 Subject: Re: [PATCH] Documentation: add a new man page for "git-help" and -i|--info option. Message-ID: <6809BA12-0200-4EA8-BB9E-D26ED5E27660@pp.inet.fi> URL: https://gitlist.dev/e/6809BA12-0200-4EA8-BB9E-D26ED5E27660%40pp.inet.fi In-Reply-To: <7vabopzfek.fsf@gitster.siamese.dyndns.org> ``` On Dec 5, 2007, at 10:58, Junio C Hamano wrote: > Perhaps your mail and my push crossed. The same fix is there at the > tip > of 'master' branch since last night. Ah, sorry, I didn't check the master, and didn't mention that the fix was for next. -- Väinö ```