{"thread":{"id":"11126","subject":"[PATCH] Documentation: add a new man page for \"git-help\" and -i|--info option.","startedAt":"2007-12-04T05:44:29Z","lastAt":"2007-12-05T11:50:17Z","messageCount":7,"participants":["Christian Couder","Junio C Hamano","Väinö Järvelä","Wincent Colaiuta"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"61866","messageId":"20071204064429.1b5007b2.chriscool@tuxfamily.org","threadId":"11126","inReplyTo":null,"subject":"[PATCH] Documentation: add a new man page for \"git-help\" and -i|--info option.","fromName":"Christian Couder","fromEmail":"chriscool@tuxfamily.org","sentAt":"2007-12-04T05:44:29Z","receivedAt":"2007-12-04T05:44:29Z","isPatch":true,"sender":{"key":"christian.couder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/208954?v=4"},"body":"Option -i|--info for \"git-help\" is documented only in the new\n\"git-help.txt\" man page, but this new man page is referenced\nfrom the \"--help\" option documentation in the \"git.txt\" man page.\n\nSigned-off-by: Christian Couder <chriscool@tuxfamily.org>\n---\n Documentation/git-help.txt |   53 ++++++++++++++++++++++++++++++++++++++++++++\n Documentation/git.txt      |   11 ++++++--\n 2 files changed, 61 insertions(+), 3 deletions(-)\n create mode 100644 Documentation/git-help.txt\n\n\tThis is a first documentation patch in my git-help\n\timprovement series. \n\ndiff --git a/Documentation/git-help.txt b/Documentation/git-help.txt\nnew file mode 100644\nindex 0000000..232daae\n--- /dev/null\n+++ b/Documentation/git-help.txt\n@@ -0,0 +1,53 @@\n+git-help(1)\n+======\n+\n+NAME\n+----\n+git-help - display help information about git\n+\n+SYNOPSIS\n+--------\n+'git help' [-a|--all|-i|--info] [COMMAND]\n+\n+DESCRIPTION\n+-----------\n+\n+With no options and no COMMAND given, the synopsis of the 'git'\n+command and a list of the most commonly used git commands are printed\n+on the standard output.\n+\n+If the option '--all' or '-a' is given, then all available commands are\n+printed on the standard output.\n+\n+If a git command is named, a manual page for that command is brought\n+up. The 'man' program is used by default for this purpose, but this\n+can be overriden by other options.\n+\n+Note that 'git --help ...' is identical as 'git help ...' because the\n+former is internally converted into the latter.\n+\n+OPTIONS\n+-------\n+-a|--all::\n+\n+\tPrints all the available commands on the standard output. This\n+\toption superseeds any other option.\n+\n+-i|--info::\n+\tUse the 'info' program to display the manual page, instead of\n+\tthe 'man' program that is used by default.\n+\n+Author\n+------\n+Written by Junio C Hamano <gitster@pobox.com> and the git-list\n+<git@vger.kernel.org>.\n+\n+Documentation\n+-------------\n+Initial documentation was part of the gitlink:git[7] man page.\n+Christian Couder <chriscool@tuxfamily.org> extracted and rewrote it a\n+little. Maintenance is done by the git-list <git@vger.kernel.org>.\n+\n+GIT\n+---\n+Part of the gitlink:git[7] suite\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex 5460201..f8d1eef 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -100,9 +100,14 @@ OPTIONS\n \n --help::\n \tPrints the synopsis and a list of the most commonly used\n-\tcommands.  If a git command is named this option will bring up\n-\tthe man-page for that command. If the option '--all' or '-a' is\n-\tgiven then all available commands are printed.\n+\tcommands. If the option '--all' or '-a' is given then all\n+\tavailable commands are printed. If a git command is named this\n+\toption will bring up the manual page for that command.\n+\n+\tOther options are available to control how the manual page is\n+\tdisplayed. See gitlink:git-help[1] for more information,\n+\tbecause 'git --help ...' is converted internally into 'git\n+\thelp ...'.\n \n --exec-path::\n \tPath to wherever your core git programs are installed.\n-- \n1.5.3.6.1993.g154f-dirty\n"},{"id":"61884","messageId":"7v4pey7suv.fsf@gitster.siamese.dyndns.org","threadId":"11126","inReplyTo":"20071204064429.1b5007b2.chriscool@tuxfamily.org","subject":"Re: [PATCH] Documentation: add a new man page for \"git-help\" and -i|--info option.","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2007-12-04T08:43:20Z","receivedAt":"2007-12-04T08:43:20Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Christian Couder <chriscool@tuxfamily.org> writes:\n\n> Option -i|--info for \"git-help\" is documented only in the new\n> \"git-help.txt\" man page, but this new man page is referenced\n> from the \"--help\" option documentation in the \"git.txt\" man page.\n>\n> Signed-off-by: Christian Couder <chriscool@tuxfamily.org>\n\nI like the addition of git-help manpage, but this ties the new manual\npage to inclusion of your \"git help -i\" series.\n\nFor now, I'd strip the description of -i and apply the remainder.  Let's\ncook -i / -w / -x enhancement idea a bit more on the list before going\nahead with it.\n"},{"id":"61983","messageId":"178B37CE-9B28-4CE2-B8A0-FCA28CF85E12@pp.inet.fi","threadId":"11126","inReplyTo":"20071204064429.1b5007b2.chriscool@tuxfamily.org","subject":"Re: [PATCH] Documentation: add a new man page for \"git-help\" and -i|--info option.","fromName":"Väinö Järvelä","fromEmail":"v@pp.inet.fi","sentAt":"2007-12-05T08:19:20Z","receivedAt":"2007-12-05T08:19:20Z","isPatch":true,"sender":{"key":"v@pp.inet.fi","avatar":null},"body":"Patch attached to fix header error in this patch.\n\n(Attached because Mail.app mangles inline patches)\n\n--\nVäinö\n\nOn Dec 4, 2007, at 07:44, Christian Couder wrote:\n\n> Option -i|--info for \"git-help\" is documented only in the new\n> \"git-help.txt\" man page, but this new man page is referenced\n> from the \"--help\" option documentation in the \"git.txt\" man page.\n>\n> Signed-off-by: Christian Couder <chriscool@tuxfamily.org>\n> ---\n> Documentation/git-help.txt |   53 +++++++++++++++++++++++++++++++++++ \n> +++++++++\n> Documentation/git.txt      |   11 ++++++--\n> 2 files changed, 61 insertions(+), 3 deletions(-)\n> create mode 100644 Documentation/git-help.txt\n>\n> \tThis is a first documentation patch in my git-help\n> \timprovement series.\n>\n> diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt\n> new file mode 100644\n> index 0000000..232daae\n> --- /dev/null\n> +++ b/Documentation/git-help.txt\n> @@ -0,0 +1,53 @@\n> +git-help(1)\n> +======\n> +\n> +NAME\n> +----\n> +git-help - display help information about git\n> +\n> +SYNOPSIS\n> +--------\n> +'git help' [-a|--all|-i|--info] [COMMAND]\n> +\n> +DESCRIPTION\n> +-----------\n> +\n> +With no options and no COMMAND given, the synopsis of the 'git'\n> +command and a list of the most commonly used git commands are printed\n> +on the standard output.\n> +\n> +If the option '--all' or '-a' is given, then all available commands  \n> are\n> +printed on the standard output.\n> +\n> +If a git command is named, a manual page for that command is brought\n> +up. The 'man' program is used by default for this purpose, but this\n> +can be overriden by other options.\n> +\n> +Note that 'git --help ...' is identical as 'git help ...' because the\n> +former is internally converted into the latter.\n> +\n> +OPTIONS\n> +-------\n> +-a|--all::\n> +\n> +\tPrints all the available commands on the standard output. This\n> +\toption superseeds any other option.\n> +\n> +-i|--info::\n> +\tUse the 'info' program to display the manual page, instead of\n> +\tthe 'man' program that is used by default.\n> +\n> +Author\n> +------\n> +Written by Junio C Hamano <gitster@pobox.com> and the git-list\n> +<git@vger.kernel.org>.\n> +\n> +Documentation\n> +-------------\n> +Initial documentation was part of the gitlink:git[7] man page.\n> +Christian Couder <chriscool@tuxfamily.org> extracted and rewrote it a\n> +little. Maintenance is done by the git-list <git@vger.kernel.org>.\n> +\n> +GIT\n> +---\n> +Part of the gitlink:git[7] suite\n> diff --git a/Documentation/git.txt b/Documentation/git.txt\n> index 5460201..f8d1eef 100644\n> --- a/Documentation/git.txt\n> +++ b/Documentation/git.txt\n> @@ -100,9 +100,14 @@ OPTIONS\n>\n> --help::\n> \tPrints the synopsis and a list of the most commonly used\n> -\tcommands.  If a git command is named this option will bring up\n> -\tthe man-page for that command. If the option '--all' or '-a' is\n> -\tgiven then all available commands are printed.\n> +\tcommands. If the option '--all' or '-a' is given then all\n> +\tavailable commands are printed. If a git command is named this\n> +\toption will bring up the manual page for that command.\n> +\n> +\tOther options are available to control how the manual page is\n> +\tdisplayed. See gitlink:git-help[1] for more information,\n> +\tbecause 'git --help ...' is converted internally into 'git\n> +\thelp ...'.\n>\n> --exec-path::\n> \tPath to wherever your core git programs are installed.\n> -- \n> 1.5.3.6.1993.g154f-dirty\n>\n> -\n> To unsubscribe from this list: send the line \"unsubscribe git\" in\n> the body of a message to majordomo@vger.kernel.org\n> More majordomo info at  http://vger.kernel.org/majordomo-info.html\n\n\n\nFrom 6d9fa82be1074a9fe6bf3fad36a838c1142966ca Mon Sep 17 00:00:00 2001\nFrom: =?utf-8?q?V=C3=A4in=C3=B6=20J=C3=A4rvel=C3=A4?= <v@pp.inet.fi>\nDate: Wed, 5 Dec 2007 10:05:48 +0200\nSubject: [PATCH] Fixed git-help.txt header error\nMIME-Version: 1.0\nContent-Type: text/plain; charset=utf-8\nContent-Transfer-Encoding: 8bit\n\nSigned-off-by: Väinö Järvelä <v@pp.inet.fi>\n---\n Documentation/git-help.txt |    2 +-\n 1 files changed, 1 insertions(+), 1 deletions(-)\n\ndiff --git a/Documentation/git-help.txt b/Documentation/git-help.txt\nindex 232daae..c94e27b 100644\n--- a/Documentation/git-help.txt\n+++ b/Documentation/git-help.txt\n@@ -1,5 +1,5 @@\n git-help(1)\n-======\n+===========\n \n NAME\n ----\n-- \n1.5.3.7.2115.geb80\n\n\n\n\n"},{"id":"61984","messageId":"B4734D40-9EE8-4B96-9426-FF5974F8488E@wincent.com","threadId":"11126","inReplyTo":"178B37CE-9B28-4CE2-B8A0-FCA28CF85E12@pp.inet.fi","subject":"Re: [PATCH] Documentation: add a new man page for \"git-help\" and -i|--info option.","fromName":"Wincent Colaiuta","fromEmail":"win@wincent.com","sentAt":"2007-12-05T08:27:53Z","receivedAt":"2007-12-05T08:27:53Z","isPatch":true,"sender":{"key":"greg@hurrell.net","avatar":"https://avatars.githubusercontent.com/u/7074?v=4"},"body":"El 5/12/2007, a las 9:19, Väinö Järvelä escribió:\n\n> Patch attached to fix header error in this patch.\n>\n> (Attached because Mail.app mangles inline patches)\n\nI'm a Mail.app user as well. Any reason why you can't use \"git send- \nemail\"? It's very useful.\n\nCheers,\nWincent\n"},{"id":"61985","messageId":"E6D70DFA-79C6-4B97-B749-DEE11F2B2B47@pp.inet.fi","threadId":"11126","inReplyTo":"B4734D40-9EE8-4B96-9426-FF5974F8488E@wincent.com","subject":"Re: [PATCH] Documentation: add a new man page for \"git-help\" and -i|--info option.","fromName":"Väinö Järvelä","fromEmail":"v@pp.inet.fi","sentAt":"2007-12-05T08:33:52Z","receivedAt":"2007-12-05T08:33:52Z","isPatch":true,"sender":{"key":"v@pp.inet.fi","avatar":null},"body":"\nOn Dec 5, 2007, at 10:27, Wincent Colaiuta wrote:\n\n> El 5/12/2007, a las 9:19, Väinö Järvelä escribió:\n>\n>> Patch attached to fix header error in this patch.\n>>\n>> (Attached because Mail.app mangles inline patches)\n>\n> I'm a Mail.app user as well. Any reason why you can't use \"git send- \n> email\"? It's very useful.\n\nI didn't remember that send-email had \"--in-reply-to\" parameter, and I  \nthought it would be cleaner to send as a reply. Thus I used Mail.app.\n\n--\nVäinö\n"},{"id":"61988","messageId":"7vabopzfek.fsf@gitster.siamese.dyndns.org","threadId":"11126","inReplyTo":"178B37CE-9B28-4CE2-B8A0-FCA28CF85E12@pp.inet.fi","subject":"Re: [PATCH] Documentation: add a new man page for \"git-help\" and -i|--info option.","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2007-12-05T08:58:43Z","receivedAt":"2007-12-05T08:58:43Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Perhaps your mail and my push crossed.  The same fix is there at the tip\nof 'master' branch since last night.\n"},{"id":"62009","messageId":"6809BA12-0200-4EA8-BB9E-D26ED5E27660@pp.inet.fi","threadId":"11126","inReplyTo":"7vabopzfek.fsf@gitster.siamese.dyndns.org","subject":"Re: [PATCH] Documentation: add a new man page for \"git-help\" and -i|--info option.","fromName":"Väinö Järvelä","fromEmail":"v@pp.inet.fi","sentAt":"2007-12-05T11:50:17Z","receivedAt":"2007-12-05T11:50:17Z","isPatch":true,"sender":{"key":"v@pp.inet.fi","avatar":null},"body":"On Dec 5, 2007, at 10:58, Junio C Hamano wrote:\n\n> Perhaps your mail and my push crossed.  The same fix is there at the  \n> tip\n> of 'master' branch since last night.\n\nAh, sorry, I didn't check the master, and didn't mention that the fix  \nwas for next.\n\n--\nVäinö"}]}