{"thread":{"id":"35881","subject":"[PATCH] provide a Git user-manual man page","startedAt":"2014-02-15T13:51:38Z","lastAt":"2014-02-18T22:14:52Z","messageCount":4,"participants":["Philip Oakley","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"234857","messageId":"1392472299-3780-1-git-send-email-philipoakley@iee.org","threadId":"35881","inReplyTo":null,"subject":"[PATCH] provide a Git user-manual man page","fromName":"Philip Oakley","fromEmail":"philipoakley@iee.org","sentAt":"2014-02-15T13:51:38Z","receivedAt":"2014-02-15T13:51:38Z","isPatch":true,"sender":{"key":"philipoakley@iee.email","avatar":"https://avatars.githubusercontent.com/u/914343?v=4"},"body":"This is a resend of my original patch ($gman/240486), which disappeared\nwithout comment. I've cc'd those who have touched the User-Manual in\nthe last year for comment on the provision of this access mechanism.\n\nThe Git User Manual is formatted as a doc book, rather than as\na man page so isn't directly accessible via the usual 'git help\n' command.\n\nThis patch provides a simple man page with onward links to the true\nUser-Manual. \n\nThe man page is based directly on a very cut down version of the git(1)\npage.\n\nThis patch is based on 1.9.0 master.\n\nPhilip Oakley (1):\n Provide a 'git help user-manual' route to the docbook\n\n Documentation/Makefile | 1 +\n Documentation/gituser-manual.txt | 34 ++++++++++++++++++++++++++++++++++\n builtin/help.c | 1 +\n 3 files changed, 36 insertions(+)\n create mode 100644 Documentation/gituser-manual.txt\n\n-- \n1.8.3.msysgit.0\n"},{"id":"234858","messageId":"1392472299-3780-2-git-send-email-philipoakley@iee.org","threadId":"35881","inReplyTo":"1392472299-3780-1-git-send-email-philipoakley@iee.org","subject":"[PATCH] Provide a 'git help user-manual' route to the docbook","fromName":"Philip Oakley","fromEmail":"philipoakley@iee.org","sentAt":"2014-02-15T13:51:39Z","receivedAt":"2014-02-15T13:51:39Z","isPatch":true,"sender":{"key":"philipoakley@iee.email","avatar":"https://avatars.githubusercontent.com/u/914343?v=4"},"body":"Signed-off-by: Philip Oakley \n---\n Documentation/Makefile | 1 +\n Documentation/gituser-manual.txt | 34 ++++++++++++++++++++++++++++++++++\n builtin/help.c | 1 +\n 3 files changed, 36 insertions(+)\n create mode 100644 Documentation/gituser-manual.txt\n\ndiff --git a/Documentation/Makefile b/Documentation/Makefile\nindex fc6b2cf..657523f 100644\n--- a/Documentation/Makefile\n+++ b/Documentation/Makefile\n@@ -31,6 +31,7 @@ MAN7_TXT += gitnamespaces.txt\n MAN7_TXT += gitrevisions.txt\n MAN7_TXT += gittutorial-2.txt\n MAN7_TXT += gittutorial.txt\n+MAN7_TXT += gituser-manual.txt\n MAN7_TXT += gitworkflows.txt\n \n MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)\ndiff --git a/Documentation/gituser-manual.txt b/Documentation/gituser-manual.txt\nnew file mode 100644\nindex 0000000..9fd4744\n--- /dev/null\n+++ b/Documentation/gituser-manual.txt\n@@ -0,0 +1,34 @@\n+gituser-manual(7)\n+=================\n+\n+NAME\n+----\n+gituser-manual - a link to the user-manual docbook\n+\n+\n+SYNOPSIS\n+--------\n+[verse]\n+'git help user-manual'\n+\n+link:user-manual.html[Git User's Manual]\n+\n+DESCRIPTION\n+-----------\n+Git is a fast, scalable, distributed revision control system with an\n+unusually rich command set that provides both high-level operations\n+and full access to internals.\n+\n+The link:user-manual.html[Git User's Manual] provides an\n+in-depth introduction to Git.\n+\n+SEE ALSO\n+--------\n+linkgit:gittutorial[7],\n+linkgit:giteveryday[7],\n+linkgit:gitcli[7],\n+linkgit:gitworkflows[7]\n+\n+GIT\n+---\n+Part of the linkgit:git[1] suite\ndiff --git a/builtin/help.c b/builtin/help.c\nindex 1fdefeb..be7c39d 100644\n--- a/builtin/help.c\n+++ b/builtin/help.c\n@@ -427,6 +427,7 @@ static struct {\n \t{ \"modules\", N_(\"Defining submodule properties\") },\n \t{ \"revisions\", N_(\"Specifying revisions and ranges for Git\") },\n \t{ \"tutorial\", N_(\"A tutorial introduction to Git (for version 1.5.1 or newer)\") },\n+\t{ \"user-manual\", N_(\"A link to the user-manual docbook\") },\n \t{ \"workflows\", N_(\"An overview of recommended workflows with Git\") },\n };\n \n-- \n1.8.3.msysgit.0\n"},{"id":"235013","messageId":"xmqqha7wdvpz.fsf@gitster.dls.corp.google.com","threadId":"35881","inReplyTo":"1392472299-3780-2-git-send-email-philipoakley@iee.org","subject":"Re: [PATCH] Provide a 'git help user-manual' route to the docbook","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2014-02-18T20:14:32Z","receivedAt":"2014-02-18T20:14:32Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Philip Oakley writes:\n\n> diff --git a/Documentation/gituser-manual.txt b/Documentation/gituser-manual.txt\n> new file mode 100644\n> index 0000000..9fd4744\n> --- /dev/null\n> +++ b/Documentation/gituser-manual.txt\n> @@ -0,0 +1,34 @@\n> +gituser-manual(7)\n> +=================\n> +\n> +NAME\n> +----\n> +gituser-manual - a link to the user-manual docbook\n> +\n> +\n> +SYNOPSIS\n> +--------\n> +[verse]\n> +'git help user-manual'\n> +\n> +link:user-manual.html[Git User's Manual]\n\nIs it just me, or is typing\n\n\t$ git help user-manual\n\nand not seeing the manual itself, but only a link you have to click\nto get there a worthwhile addition?\n\nI would not mind having a clickable link in the output from\n\n\t$ git help git\n\nor something that does already have other useful information, though.\n\n> +\n> +DESCRIPTION\n> +-----------\n> +Git is a fast, scalable, distributed revision control system with an\n> +unusually rich command set that provides both high-level operations\n> +and full access to internals.\n> +\n> +The link:user-manual.html[Git User's Manual] provides an\n> +in-depth introduction to Git.\n> +\n> +SEE ALSO\n> +--------\n> +linkgit:gittutorial[7],\n> +linkgit:giteveryday[7],\n> +linkgit:gitcli[7],\n> +linkgit:gitworkflows[7]\n> +\n> +GIT\n> +---\n> +Part of the linkgit:git[1] suite\n> diff --git a/builtin/help.c b/builtin/help.c\n> index 1fdefeb..be7c39d 100644\n> --- a/builtin/help.c\n> +++ b/builtin/help.c\n> @@ -427,6 +427,7 @@ static struct {\n> \t{ \"modules\", N_(\"Defining submodule properties\") },\n> \t{ \"revisions\", N_(\"Specifying revisions and ranges for Git\") },\n> \t{ \"tutorial\", N_(\"A tutorial introduction to Git (for version 1.5.1 or newer)\") },\n> +\t{ \"user-manual\", N_(\"A link to the user-manual docbook\") },\n> \t{ \"workflows\", N_(\"An overview of recommended workflows with Git\") },\n> };\n"},{"id":"235028","messageId":"5561391C5EED4114A90C35518558A267@PhilipOakley","threadId":"35881","inReplyTo":"xmqqha7wdvpz.fsf@gitster.dls.corp.google.com","subject":"Re: [PATCH] Provide a 'git help user-manual' route to the docbook","fromName":"Philip Oakley","fromEmail":"philipoakley@iee.org","sentAt":null,"receivedAt":"2014-02-18T22:14:52Z","isPatch":true,"sender":{"key":"philipoakley@iee.email","avatar":"https://avatars.githubusercontent.com/u/914343?v=4"},"body":"From: \"Junio C Hamano\" \n> Philip Oakley writes:\n>\n>> diff --git a/Documentation/gituser-manual.txt \n>> b/Documentation/gituser-manual.txt\n>> new file mode 100644\n>> index 0000000..9fd4744\n>> --- /dev/null\n>> +++ b/Documentation/gituser-manual.txt\n>> @@ -0,0 +1,34 @@\n>> +gituser-manual(7)\n>> +=================\n>> +\n>> +NAME\n>> +----\n>> +gituser-manual - a link to the user-manual docbook\n>> +\n>> +\n>> +SYNOPSIS\n>> +--------\n>> +[verse]\n>> +'git help user-manual'\n>> +\n>> +link:user-manual.html[Git User's Manual]\n>\n> Is it just me, or is typing\n>\n> $ git help user-manual\n>\n> and not seeing the manual itself, but only a link you have to click\n> to get there a worthwhile addition?\n\nIt is a half-way house, partly because the current 'git help ' \nprocessing always assumes that the target is a man page, and that the \npage name will always be 'git. Thus the current user-manual isn't \nimmediately visible to the help system. Also it's not (quite reasonably) \nformatted as a man page either.\n\nThis was an attempt to offer more ways for users to discover the \nuser-manual, as it would also be listed in the 'git help -g' output. To \nmake that work required a proper man-page, hence the patch. Also I was \navoiding the renaming of the user-manual.txt & user-manual.html file \nbecause of possible link breakages from external sources.\n\n>\n> I would not mind having a clickable link in the output from\n>\n> $ git help git\n\nThere is now a link within the git(1) page, though folk maybe leaping \npast it to the list of commands and env variables, etc.\n\nI'm generally in favour of providing more help sign-posting from more \ndirections where possible.\n\n>\n> or something that does already have other useful information, though.\n>\n>> +\n>> +DESCRIPTION\n>> +-----------\n>> +Git is a fast, scalable, distributed revision control system with an\n>> +unusually rich command set that provides both high-level operations\n>> +and full access to internals.\n>> +\n>> +The link:user-manual.html[Git User's Manual] provides an\n>> +in-depth introduction to Git.\n>> +\n>> +SEE ALSO\n>> +--------\n>> +linkgit:gittutorial[7],\n>> +linkgit:giteveryday[7],\n>> +linkgit:gitcli[7],\n>> +linkgit:gitworkflows[7]\n>> +\n>> +GIT\n>> +---\n>> +Part of the linkgit:git[1] suite\n>> diff --git a/builtin/help.c b/builtin/help.c\n>> index 1fdefeb..be7c39d 100644\n>> --- a/builtin/help.c\n>> +++ b/builtin/help.c\n>> @@ -427,6 +427,7 @@ static struct {\n>> { \"modules\", N_(\"Defining submodule properties\") },\n>> { \"revisions\", N_(\"Specifying revisions and ranges for Git\") },\n>> { \"tutorial\", N_(\"A tutorial introduction to Git (for version 1.5.1 \n>> or newer)\") },\n>> + { \"user-manual\", N_(\"A link to the user-manual docbook\") },\n>> { \"workflows\", N_(\"An overview of recommended workflows with \n>> Git\") },\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"}]}