{"thread":{"id":"27231","subject":"[PATCH] Add --info-path and --man-path options to git.","startedAt":"2011-05-01T08:16:25Z","lastAt":"2011-05-02T17:24:05Z","messageCount":14,"participants":["Jon Seymour","Junio C Hamano","Jonathan Nieder"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"166809","messageId":"1304237785-56101-1-git-send-email-jon.seymour@gmail.com","threadId":"27231","inReplyTo":null,"subject":"[PATCH] Add --info-path and --man-path options to git.","fromName":"Jon Seymour","fromEmail":"jon.seymour@gmail.com","sentAt":"2011-05-01T08:16:25Z","receivedAt":"2011-05-01T08:16:25Z","isPatch":true,"sender":{"key":"jon.seymour@gmail.com","avatar":"https://avatars.githubusercontent.com/u/207131?v=4"},"body":"To better support git extensions provided by 3rd parties\nwhich would like to install their own man pages and Info files\nin the same place as git's own man pages and Info files\nadd support for --man-path and --info-path options.\n\nSigned-off-by: Jon Seymour \n---\n Documentation/git.txt | 10 +++++++++-\n Makefile | 4 +++-\n git.c | 8 +++++++-\n 3 files changed, 19 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex e4d43a9..c495322 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -9,7 +9,7 @@ git - the stupid content tracker\n SYNOPSIS\n --------\n [verse]\n-'git' [--version] [--exec-path[=]] [--html-path]\n+'git' [--version] [--exec-path[=]] [--html-path] [--man-path] [--info-path]\n [-p|--paginate|--no-pager] [--no-replace-objects]\n [--bare] [--git-dir=] [--work-tree=]\n [-c =]\n@@ -285,6 +285,14 @@ help ...`.\n \tPrint the path to wherever your git HTML documentation is installed\n \tand exit.\n \n+--man-path::\n+\tPrint the path to wherever your git man pages are installed\n+\tand exit.\n+\n+--info-path::\n+\tPrint the path to wherever your git Info files are installed\n+\tand exit.\n+\n -p::\n --paginate::\n \tPipe all output into 'less' (or if set, $PAGER) if standard\ndiff --git a/Makefile b/Makefile\nindex f5308fe..9119aaa 100644\n--- a/Makefile\n+++ b/Makefile\n@@ -1684,7 +1684,9 @@ strip: $(PROGRAMS) git$X\n \n git.o: common-cmds.h\n git.s git.o: EXTRA_CPPFLAGS = -DGIT_VERSION='\"$(GIT_VERSION)\"' \\\n-\t'-DGIT_HTML_PATH=\"$(htmldir_SQ)\"'\n+\t'-DGIT_HTML_PATH=\"$(htmldir_SQ)\"' \\\n+\t'-DGIT_MAN_PATH=\"$(mandir_SQ)\"' \\\n+\t'-DGIT_INFO_PATH=\"$(infodir_SQ)\"'\n \n git$X: git.o $(BUILTIN_OBJS) $(GITLIBS)\n \t$(QUIET_LINK)$(CC) $(ALL_CFLAGS) -o $@ git.o \\\ndiff --git a/git.c b/git.c\nindex ef598c3..60a9403 100644\n--- a/git.c\n+++ b/git.c\n@@ -6,7 +6,7 @@\n #include \"run-command.h\"\n \n const char git_usage_string[] =\n-\t\"git [--version] [--exec-path[=]] [--html-path]\\n\"\n+\t\"git [--version] [--exec-path[=]] [--html-path] [--man-path] [--info-path]\\n\"\n \t\" [-p|--paginate|--no-pager] [--no-replace-objects]\\n\"\n \t\" [--bare] [--git-dir=] [--work-tree=]\\n\"\n \t\" [-c name=value] [--help]\\n\"\n@@ -95,6 +95,12 @@ static int handle_options(const char ***argv, int *argc, int *envchanged)\n \t\t} else if (!strcmp(cmd, \"--html-path\")) {\n \t\t\tputs(system_path(GIT_HTML_PATH));\n \t\t\texit(0);\n+\t\t} else if (!strcmp(cmd, \"--man-path\")) {\n+\t\t\tputs(system_path(GIT_MAN_PATH));\n+\t\t\texit(0);\n+\t\t} else if (!strcmp(cmd, \"--info-path\")) {\n+\t\t\tputs(system_path(GIT_INFO_PATH));\n+\t\t\texit(0);\n \t\t} else if (!strcmp(cmd, \"-p\") || !strcmp(cmd, \"--paginate\")) {\n \t\t\tuse_pager = 1;\n \t\t} else if (!strcmp(cmd, \"--no-pager\")) {\n-- \n1.7.5.rc3.46.g7f712.dirty\n"},{"id":"166817","messageId":"7vbozmthhy.fsf@alter.siamese.dyndns.org","threadId":"27231","inReplyTo":"1304237785-56101-1-git-send-email-jon.seymour@gmail.com","subject":"Re: [PATCH] Add --info-path and --man-path options to git.","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2011-05-01T18:15:05Z","receivedAt":"2011-05-01T18:15:05Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jon Seymour writes:\n\n> To better support git extensions provided by 3rd parties\n> which would like to install their own man pages and Info files\n> in the same place as git's own man pages and Info files\n> add support for --man-path and --info-path options.\n>\n> Signed-off-by: Jon Seymour \n> ---\n\nThis an improvement that is pretty much independent from the issue of\nthird party extensions. In fact, even people who would oppose to the idea\nof any third party crap [*1*] contaminating the install directories owned\nby git may want to this patch.\n\nIt is useful to have these options even for read-only users. Cf. 89a56bf\n(add --html-path to get the location of installed HTML docs, 2009-04-05).\n\nI'll rewrite the proposed commit message before queuing this to 'pu'.\n\nThanks.\n\n\n[Footnote]\n\n*1* Not all extensions may be crappy, but some extension will be, and you\nmay find out the crappiness only after installing it, but at that point it\nalready has contaminated your git directories.\n"},{"id":"166827","messageId":"BANLkTim1SKiD5va_2TBLkrn6-N9oJuSEug@mail.gmail.com","threadId":"27231","inReplyTo":"7vbozmthhy.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH] Add --info-path and --man-path options to git.","fromName":"Jon Seymour","fromEmail":"jon.seymour@gmail.com","sentAt":"2011-05-01T22:47:22Z","receivedAt":"2011-05-01T22:47:22Z","isPatch":true,"sender":{"key":"jon.seymour@gmail.com","avatar":"https://avatars.githubusercontent.com/u/207131?v=4"},"body":"On Mon, May 2, 2011 at 4:15 AM, Junio C Hamano wrote:\n> Jon Seymour writes:\n>\n>> To better support git extensions provided by 3rd parties\n>> which would like to install their own man pages and Info files\n>> in the same place as git's own man pages and Info files\n>> add support for --man-path and --info-path options.\n>>\n>> Signed-off-by: Jon Seymour \n>> ---\n>\n> This an improvement that is pretty much independent from the issue of\n> third party extensions. In fact, even people who would oppose to the idea\n> of any third party crap [*1*] contaminating the install directories owned\n> by git may want to this patch.\n>\n\nThanks.\n\nI agree the sentiment that suggests that we don't want to pollute\ngit's own directories with 3rd party contributions.\n\nThis, indeed, is part of the motivation for a --plugins-path option\nwhich would provide a physically separate location for 3rd party\ncontributions, per the earlier discussions between yourself and\nJonathan Nieder. I'll put together a suggested patch for how this\nmight work in the next week or so.\n\njon.\n"},{"id":"166828","messageId":"20110501234833.GC11550@elie","threadId":"27231","inReplyTo":"7vbozmthhy.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH] Add --info-path and --man-path options to git.","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2011-05-01T23:48:33Z","receivedAt":"2011-05-01T23:48:33Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Junio C Hamano wrote:\n\n> This an improvement that is pretty much independent from the issue of\n> third party extensions. In fact, even people who would oppose to the idea\n> of any third party crap [*1*] contaminating the install directories owned\n> by git may want to this patch.\n>\n> It is useful to have these options even for read-only users. Cf. 89a56bf\n> (add --html-path to get the location of installed HTML docs, 2009-04-05).\n\nI don't mind this patch at all, but I do not have a full picture yet\nof how it helps.\n\nIn the case of HTML, the standard way to show git documentation in your\ncustom documentation viewer is to pull up file://$(git --html-path)/index.html,\nusing the full path to the HTML files. So if \"git gui\" were to gain a\ndocumentation viewer widget instead of relying on git web--browse, it\nwould need the HTML path.\n\nBy contrast, man and info typically use standard search mechanisms:\nman using $MANPATH and info using the dir.info file. The usual\ninterface to git's documentation through a man browser is not\n\n\tman /usr/share/man/man1/git-add.1.gz\n\nbut\n\n\tman git-add;\t# or \"man git add\" if your man viewer supports it\n\nAnd the usual interface through an info browser is\n\n\tinfo git\n\n.\n\nSo it is not clear to me how this would help when you want to view\ndocumentation. Similarly, if you want to sneak documentation into an\nexisting git installation (ignoring the question of whether that's a\ngood idea), using HTML you would have to modify git's index.html and\nadd your HTML files alongside it, while using \"man\" or \"info\" you\nwould have to modify the index page (git.1 or gitman.info) but could\nput your custom pages wherever you want in the viewer's search path.\n\nSo while I can't see the harm in exposing --info-path and --man-path,\nthe current patch seems to do an incomplete job of documenting them.\nPerhaps this is about finding the documentation corresponding to a\nparticular copy of git when a machine has multiple copies?\n"},{"id":"166829","messageId":"20110501235332.GD11550@elie","threadId":"27231","inReplyTo":"20110501234833.GC11550@elie","subject":"Re: [PATCH] Add --info-path and --man-path options to git.","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2011-05-01T23:53:32Z","receivedAt":"2011-05-01T23:53:32Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Hi again,\n\nTwo quick corrections.\n\nJonathan Nieder wrote:\n\n> So if \"git gui\" were to gain a\n> documentation viewer widget instead of relying on git web--browse, it\n> would need the HTML path.\n\nActually, it already uses the HTML path. :)\n\n> So while I can't see the harm in exposing --info-path and --man-path,\n> the current patch seems to do an incomplete job of documenting them.\n> Perhaps this is about finding the documentation corresponding to a\n> particular copy of git when a machine has multiple copies?\n\nIt seems Jon's and my mails crossed. Here's another use case for\n--man-path: if your frontend wants to fall back to HTML documentation\nwithout spawning a man pager when the manpages are not installed, it\nneeds to know where to look.\n\n(See also gitgui-0.6.0~32, git-gui: Offer quick access to the HTML\nformatted documentation, 2007-01-28)\n"},{"id":"166833","messageId":"7v62puq8a5.fsf@alter.siamese.dyndns.org","threadId":"27231","inReplyTo":"20110501234833.GC11550@elie","subject":"Re: [PATCH] Add --info-path and --man-path options to git.","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2011-05-02T00:02:26Z","receivedAt":"2011-05-02T00:02:26Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jonathan Nieder writes:\n\n> By contrast, man and info typically use standard search mechanisms:\n> man using $MANPATH and info using the dir.info file. The usual\n> interface to git's documentation through a man browser is not\n>\n> \tman /usr/share/man/man1/git-add.1.gz\n>\n> but\n>\n> \tman git-add;\t# or \"man git add\" if your man viewer supports it\n\nI think you are forgetting the case where the git-man-path the user uses\nto install git may be outside /usr/share/man (e.g. $HOME/share/man). In\nsuch an installation, by setting $PATH to include your installed git\nbinary (e.g. $HOME/bin), you should be able to say \"git help -m git\" to\ntell help.c to internally prepend $HOME/share/man to the $MANPATH before\nit kicks \"man\". Does \"man git-add\" work without you knowing where that\ndirectory is (iow, without having $HOME/share/man on $MANPATH)? And if it\ndoes not, how would you learn what directory to add to your $MANPATH?\n\nIsn't that what this patch is solving? I am not sure where the similarity\nwith the html documentation breaks donw. The same thing for info.\n"},{"id":"166834","messageId":"BANLkTik-8WVsw-_P7=-pEiXFLeoQQRAVeg@mail.gmail.com","threadId":"27231","inReplyTo":"7v62puq8a5.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH] Add --info-path and --man-path options to git.","fromName":"Jon Seymour","fromEmail":"jon.seymour@gmail.com","sentAt":"2011-05-02T00:06:40Z","receivedAt":"2011-05-02T00:06:40Z","isPatch":true,"sender":{"key":"jon.seymour@gmail.com","avatar":"https://avatars.githubusercontent.com/u/207131?v=4"},"body":"On Mon, May 2, 2011 at 10:02 AM, Junio C Hamano wrote:\n> Jonathan Nieder writes:\n>\n>> By contrast, man and info typically use standard search mechanisms:\n>> man using $MANPATH and info using the dir.info file.  The usual\n>> interface to git's documentation through a man browser is not\n>>\n>>       man /usr/share/man/man1/git-add.1.gz\n>>\n>> but\n>>\n>>       man git-add;    # or \"man git add\" if your man viewer supports it\n>\n> I think you are forgetting the case where the git-man-path the user uses\n> to install git may be outside /usr/share/man (e.g. $HOME/share/man).  In\n> such an installation, by setting $PATH to include your installed git\n> binary (e.g. $HOME/bin), you should be able to say \"git help -m git\" to\n> tell help.c to internally prepend $HOME/share/man to the $MANPATH before\n> it kicks \"man\".  Does \"man git-add\" work without you knowing where that\n> directory is (iow, without having $HOME/share/man on $MANPATH)?  And if it\n> does not, how would you learn what directory to add to your $MANPATH?\n>\n> Isn't that what this patch is solving?  I am not sure where the similarity\n> with the html documentation breaks donw.  The same thing for info.\n\nGood point. For non-distro installed installations of git, this would\nbe handy, even for read-only purposes.\n\njon.\n"},{"id":"166835","messageId":"BANLkTin7ozKg8E40N3Nas_TSROt4awfEAw@mail.gmail.com","threadId":"27231","inReplyTo":"BANLkTik-8WVsw-_P7=-pEiXFLeoQQRAVeg@mail.gmail.com","subject":"Re: [PATCH] Add --info-path and --man-path options to git.","fromName":"Jon Seymour","fromEmail":"jon.seymour@gmail.com","sentAt":"2011-05-02T00:12:51Z","receivedAt":"2011-05-02T00:12:51Z","isPatch":true,"sender":{"key":"jon.seymour@gmail.com","avatar":"https://avatars.githubusercontent.com/u/207131?v=4"},"body":"On Mon, May 2, 2011 at 10:06 AM, Jon Seymour wrote:\n> On Mon, May 2, 2011 at 10:02 AM, Junio C Hamano wrote:\n>\n\nBTW: should it be --man-path and --info-path or --man-dir and --info-dir.\n\nI chose --man-path to be consistent with the other options, but in\nreality, I think all these options specify directories rather than\npaths (e.g. lists of directories).\n\njon.\n"},{"id":"166836","messageId":"20110502002535.GE11550@elie","threadId":"27231","inReplyTo":"7v62puq8a5.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH] Add --info-path and --man-path options to git.","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2011-05-02T00:25:35Z","receivedAt":"2011-05-02T00:25:35Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Junio C Hamano wrote:\n> Jonathan Nieder writes:\n\n>> The usual\n>> interface to git's documentation through a man browser is not\n>>\n>> \tman /usr/share/man/man1/git-add.1.gz\n>>\n>> but\n>>\n>> \tman git-add;\t# or \"man git add\" if your man viewer supports it\n>\n> I think you are forgetting the case where the git-man-path the user uses\n> to install git may be outside /usr/share/man (e.g. $HOME/share/man). In\n> such an installation, by setting $PATH to include your installed git\n> binary (e.g. $HOME/bin), you should be able to say \"git help -m git\" to\n> tell help.c to internally prepend $HOME/share/man to the $MANPATH before\n> it kicks \"man\".\n\nI was not forgetting it, but you are right that we have an opportunity\nto be more helpful in that case. (My own MANPATH already includes\n~/share/man, but I can see that it is easy to forget to add.)\n\nI am still not very happy about it. The man browser is in a much\nbetter position to help: the default MANPATH (at least under Debian;\nsee manpath(5)[1]) is generated by mapping $PATH entries on the fly, and\nit seems like only an oversight that it deals with directories under\n/usr but not /home. And it does not thrill me that we would be\ntraining people that\n\n\tgit help git\n\nwill cover for the installer's mistakes, while the more conventional\n\n\tman git\n\nmechanism (which is also used for other programs installed to $HOME)\nwill not.\n\n> Isn't that what this patch is solving?\n\nI find the \"use the right version of help when multiple copies of git\"\nuse case compelling enough already. Please don't mind my complaints\ntoo much.\n\nThanks for clarifying.\nJonathan\n\n[1] http://man.he.net/man5/manpath\n"},{"id":"166837","messageId":"7vzkn5pxv5.fsf@alter.siamese.dyndns.org","threadId":"27231","inReplyTo":"20110502002535.GE11550@elie","subject":"Re: [PATCH] Add --info-path and --man-path options to git.","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2011-05-02T03:47:26Z","receivedAt":"2011-05-02T03:47:26Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jonathan Nieder writes:\n\n> I am still not very happy about it. The man browser is in a much\n> better position to help: the default MANPATH (at least under Debian;\n> see manpath(5)[1]) is generated by mapping $PATH entries on the fly, and\n> it seems like only an oversight that it deals with directories under\n> /usr but not /home. And it does not thrill me that we would be\n> training people that\n>\n> \tgit help git\n>\n> will cover for the installer's mistakes, while the more conventional\n>\n> \tman git\n>\n> mechanism (which is also used for other programs installed to $HOME)\n> will not.\n\nWell, is there anything I can do to help your unhappiness about that?\n\nWhere is your unhappiness coming from? Is this your argument?\n\n\t'git help' allows distros' oversight with its -m and -i options;\n\tit discourages distros to get their act together.\n\nI personally do not think punishing users of distros by not helping would\nbe an effective way to encourage distros to help their users, so even\nthough I kind of agree with that statement, I wouldn't conclude that with\n\"therefore, git shouldn't try to be helpful with 'help [-m|-i]'\".\n"},{"id":"166838","messageId":"20110502051507.GB14547@elie","threadId":"27231","inReplyTo":"7vzkn5pxv5.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH] Add --info-path and --man-path options to git.","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2011-05-02T05:15:07Z","receivedAt":"2011-05-02T05:15:07Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Junio C Hamano wrote:\n\n> Where is your unhappiness coming from? Is this your argument?\n>\n>\t'git help' allows distros' oversight with its -m and -i options;\n>\tit discourages distros to get their act together.\n\nNo, my discomfort was not on behalf of distros. It wouldn't do\nanything to help or hurt distros, since they would be installing to\n/usr/share/man.\n\nWhen I said \"installers' mistakes\", I specifically meant the user that\ninstalls manual pages to ~/share/man without setting MANPATH to\ninclude that. I agreed that that's an unfortunate thing to happen to\nanybody, but I didn't think git is the right place to fix it. Because\nit affects anyone else installing something to $HOME, and as a user I\nwouldn't _expect_ git to fix it.\n\nWhat my analysis was missing is that this is not only about the user\nwho runs \"git help -m\" as a fancy way of running \"man git\" and expects\nit to work better (who I still have no sympathy for). It is much more\nabout the user who runs\n\n\tgit add --help\n\nor chooses Help → Manual in her porcelain, who certainly deserves some\ndocumentation whether her MANPATH is set correctly or not.\n\nI also should have remembered v1.5.4-rc0~54 (Let git-help prefer\nman-pages installed with this version of git, 2007-12-06), which is\nabout showing the manual in /opt/git-next/man in preference to a stale\nmanpage from /opt/git-master/man when running\n\"/opt/git-next/bin/git add --help\".\n\nSo I was very confused indeed. Sorry to waste your time, and thanks\nfor setting me straight.\n"},{"id":"166840","messageId":"20110502060745.GC14547@elie","threadId":"27231","inReplyTo":"1304237785-56101-1-git-send-email-jon.seymour@gmail.com","subject":"[PATCH] Documentation: clarify meaning of --html-path, --man-path, and --info-path","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2011-05-02T06:07:45Z","receivedAt":"2011-05-02T06:07:45Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"These options tell UI programs where git put its documentation, so\n\"Help\" actions can show the documentation for *this* version of git\nwithout regard to how MANPATH and INFOPATH are set up. Details:\n\n. Each variable tells where documentation is expected to be. They do\n not indicate whether documentation was actually installed.\n\n. The output of \"git --html-path\" is an absolute path and can be used\n in \"file://$(git --html-path)/git-add.html\" to name the HTML file\n documenting a particular command.\n\n. --man-path names a manual page hierarchy (e.g.,\n /home/user/share/man). Its output can be passed to \"man -M\" or put\n at the beginning of $MANPATH.\n\n. --info-path names a directory with info files (e.g.,\n /home/user/share/info). Its output is suitable as an argument to\n \"info -d\" or for inclusion in $INFOPATH.\n\nHelped-by: Junio C Hamano \nSigned-off-by: Jonathan Nieder \n---\nSorry for the long tangent. Maybe a summary can be useful.\n\n Documentation/git.txt | 12 ++++++------\n 1 files changed, 6 insertions(+), 6 deletions(-)\n\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex 7e9b521..5295315 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -287,16 +287,16 @@ help ...`.\n \tthe current setting and then exit.\n \n --html-path::\n-\tPrint the path to wherever your git HTML documentation is installed\n-\tand exit.\n+\tPrint the path, without trailing slash, where git's HTML\n+\tdocumentation is installed and exit.\n \n --man-path::\n-\tPrint the path to wherever your git man pages are installed\n-\tand exit.\n+\tPrint the manpath (see `man(1)`) for the man pages for\n+\tthis version of git and exit.\n \n --info-path::\n-\tPrint the path to wherever your git Info files are installed\n-\tand exit.\n+\tPrint the path where the Info files documenting this\n+\tversion of git are installed and exit.\n \n -p::\n --paginate::\n-- \n1.7.5\n"},{"id":"166841","messageId":"BANLkTika6j_Ja3LYLvq7aLFzD-hsqQQeWw@mail.gmail.com","threadId":"27231","inReplyTo":"20110502060745.GC14547@elie","subject":"Re: [PATCH] Documentation: clarify meaning of --html-path, --man-path, and --info-path","fromName":"Jon Seymour","fromEmail":"jon.seymour@gmail.com","sentAt":"2011-05-02T06:49:21Z","receivedAt":"2011-05-02T06:49:21Z","isPatch":true,"sender":{"key":"jon.seymour@gmail.com","avatar":"https://avatars.githubusercontent.com/u/207131?v=4"},"body":"Acked.\n\nOn Mon, May 2, 2011 at 4:07 PM, Jonathan Nieder wrote:\n> These options tell UI programs where git put its documentation, so\n> \"Help\" actions can show the documentation for *this* version of git\n> without regard to how MANPATH and INFOPATH are set up.  Details:\n>\n> . Each variable tells where documentation is expected to be.  They do\n>  not indicate whether documentation was actually installed.\n>\n> . The output of \"git --html-path\" is an absolute path and can be used\n>  in \"file://$(git --html-path)/git-add.html\" to name the HTML file\n>  documenting a particular command.\n>\n> . --man-path names a manual page hierarchy (e.g.,\n>  /home/user/share/man).  Its output can be passed to \"man -M\" or put\n>  at the beginning of $MANPATH.\n>\n> . --info-path names a directory with info files (e.g.,\n>  /home/user/share/info).  Its output is suitable as an argument to\n>  \"info -d\" or for inclusion in $INFOPATH.\n>\n> Helped-by: Junio C Hamano \n> Signed-off-by: Jonathan Nieder \n> ---\n> Sorry for the long tangent.  Maybe a summary can be useful.\n>\n>  Documentation/git.txt |   12 ++++++------\n>  1 files changed, 6 insertions(+), 6 deletions(-)\n>\n> diff --git a/Documentation/git.txt b/Documentation/git.txt\n> index 7e9b521..5295315 100644\n> --- a/Documentation/git.txt\n> +++ b/Documentation/git.txt\n> @@ -287,16 +287,16 @@ help ...`.\n>        the current setting and then exit.\n>\n>  --html-path::\n> -       Print the path to wherever your git HTML documentation is installed\n> -       and exit.\n> +       Print the path, without trailing slash, where git's HTML\n> +       documentation is installed and exit.\n>\n>  --man-path::\n> -       Print the path to wherever your git man pages are installed\n> -       and exit.\n> +       Print the manpath (see `man(1)`) for the man pages for\n> +       this version of git and exit.\n>\n>  --info-path::\n> -       Print the path to wherever your git Info files are installed\n> -       and exit.\n> +       Print the path where the Info files documenting this\n> +       version of git are installed and exit.\n>\n>  -p::\n>  --paginate::\n> --\n> 1.7.5\n>\n>\n"},{"id":"166881","messageId":"7vmxj5nhhm.fsf@alter.siamese.dyndns.org","threadId":"27231","inReplyTo":"20110502060745.GC14547@elie","subject":"Re: [PATCH] Documentation: clarify meaning of --html-path, --man-path, and --info-path","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2011-05-02T17:24:05Z","receivedAt":"2011-05-02T17:24:05Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Thanks.\n"}]}