{"thread":{"id":"30158","subject":"Bad Man Page URLs","startedAt":"2012-04-06T01:48:19Z","lastAt":"2012-05-02T21:46:02Z","messageCount":21,"participants":["David E. Wheeler","Jeff King","Jonathan Nieder","Junio C Hamano","Scott Chacon","Jakub Narebski"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"188618","messageId":"2AC038A1-3D8D-425E-92B3-DADFD027761A@justatheory.com","threadId":"30158","inReplyTo":null,"subject":"Bad Man Page URLs","fromName":"David E. Wheeler","fromEmail":"david@justatheory.com","sentAt":"2012-04-06T01:48:19Z","receivedAt":"2012-04-06T01:48:19Z","isPatch":false,"sender":{"key":"david@justatheory.com","avatar":"https://gravatar.com/avatar/17283ea1e4276cc8e69df64f9c5c731fa97d480f97694231f43384e186bdcd90?d=mp&s=160"},"body":"Hello,\n\nI noticed this in 1.7.7.3, but just rebuilt 1.7.9.6 from source on OS X Lion and am still seeing it. These are the links at the end of `man git`:\n\n> NOTES\n>         1. Everyday Git\n>            file:///home/junio/share/doc/git-doc/everyday.html\n> \n>         2. Git User's Manual\n>            file:///home/junio/share/doc/git-doc/user-manual.html\n> \n>         3. git concepts chapter of the user-manual\n>            file:///home/junio/share/doc/git-doc/user-manual.html#git-concepts\n> \n>         4. howto\n>            file:///home/junio/share/doc/git-doc/howto-index.html\n> \n>         5. GIT API documentation\n>            file:///home/junio/share/doc/git-doc/technical/api-index.html\n> \n>         6. git@vger.kernel.org\n>            mailto:git@vger.kernel.org\n\nThose URLs are sadly not useful. :-( FYI, here’s the script I use to build Git:\n\n  https://github.com/theory/my-cap/blob/master/bin/git.sh\n\nNote that the man pages are installed with these two lines:\n\n    curl -O http://git-core.googlecode.com/files/git-manpages-$VERSION.tar.gz\n    sudo tar xzv -C /usr/local/share/man -f git-manpages-$VERSION.tar.gz\n\nIs there a bug reporting system I should report this to?\n\nThanks,\n\nDavid\n"},{"id":"188621","messageId":"20120406023223.GB16264@sigill.intra.peff.net","threadId":"30158","inReplyTo":"2AC038A1-3D8D-425E-92B3-DADFD027761A@justatheory.com","subject":"Re: Bad Man Page URLs","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2012-04-06T02:32:23Z","receivedAt":"2012-04-06T02:32:23Z","isPatch":false,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Thu, Apr 05, 2012 at 06:48:19PM -0700, David E. Wheeler wrote:\n\n> I noticed this in 1.7.7.3, but just rebuilt 1.7.9.6 from source on OS\n> X Lion and am still seeing it. These are the links at the end of `man\n> git`:\n> [...]\n> >         1. Everyday Git\n> >            file:///home/junio/share/doc/git-doc/everyday.html\n\nThe problem is that you are not really rebuilding the manpages at all,\nbut rather just untarring prebuilt copies. If you built them yourself,\nthey would have the proper prefix for your system.\n\nThat being said, it would be nice for the prebuilt manpages to have\nsomething more location-agnostic in them. These links are generated by\nasciidoc's \"link:\" directive. The HTML versions properly use relative\nlinks, but the links are expanded into full URLs for the manpages. Which\nmakes sense, since there's no concept of a relative link here.\n\nSo we can tweak it by using a custom link macro (we already have\n\"linkgit\" for linking to actual commands). But what should the agnostic\nversion say? Just saying \"look at everday.html in the git documentation\"\nis not as nice as a real URL, but we really don't have any more\ninformation than that. Maybe they should be pointing to some canonical\nversion on the web?\n\n> Is there a bug reporting system I should report this to?\n\nThis list, and you just did. :)\n\n-Peff\n"},{"id":"188623","messageId":"20120406025457.GA23997@sigill.intra.peff.net","threadId":"30158","inReplyTo":"20120406023223.GB16264@sigill.intra.peff.net","subject":"Re: Bad Man Page URLs","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2012-04-06T02:54:57Z","receivedAt":"2012-04-06T02:54:57Z","isPatch":false,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Thu, Apr 05, 2012 at 10:32:23PM -0400, Jeff King wrote:\n\n> That being said, it would be nice for the prebuilt manpages to have\n> something more location-agnostic in them. These links are generated by\n> asciidoc's \"link:\" directive. The HTML versions properly use relative\n> links, but the links are expanded into full URLs for the manpages. Which\n> makes sense, since there's no concept of a relative link here.\n> \n> So we can tweak it by using a custom link macro (we already have\n> \"linkgit\" for linking to actual commands). But what should the agnostic\n> version say? Just saying \"look at everday.html in the git documentation\"\n> is not as nice as a real URL, but we really don't have any more\n> information than that. Maybe they should be pointing to some canonical\n> version on the web?\n\nI dug on this a little more. It seems that the \"link\" macro in asciidoc\nis overridable, so we could just redefine it as appropriate. However,\nthe existing implementation actually generates a reasonable-looking\ndocbook <ulink>, and it is docbook that is responsible for turning it\ninto an absolute URL.\n\nSo I think technically the docbook part of the toolchain would be the\nright place to fix this. But it may be easier to hack around it at the\nasciidoc level.\n\nSomething like the code below would work:\n\ndiff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf\nindex aea8627..1edbabe 100644\n--- a/Documentation/asciidoc.conf\n+++ b/Documentation/asciidoc.conf\n@@ -93,3 +93,10 @@ ifdef::backend-xhtml11[]\n [linkgit-inlinemacro]\n <a href=\"{target}.html\">{target}{0?({0})}</a>\n endif::backend-xhtml11[]\n+\n+ifdef::generic-location[]\n+ifdef::backend-docbook[]\n+[link-inlinemacro]\n+<ulink url=\"http://official-location/{target}\">{0={target}}</ulink>\n+endif::backend-docbook[]\n+endif::generic-location[]\n\nthough it assumes that link targets are relative. There are a handful of\ninstances where that is not the case (we can either introduce a linkabs\nfor them, or leave them and switch most of the existing link: macros\nover to linkrel: or something).\n\n-Peff\n"},{"id":"188628","messageId":"20120406042215.GA3938@burratino","threadId":"30158","inReplyTo":"20120406025457.GA23997@sigill.intra.peff.net","subject":"Re: Bad Man Page URLs","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2012-04-06T04:22:15Z","receivedAt":"2012-04-06T04:22:15Z","isPatch":false,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Jeff King wrote:\n\n> So I think technically the docbook part of the toolchain would be the\n> right place to fix this. But it may be easier to hack around it at the\n> asciidoc level.\n\nIsn't this what MAN_BASE_URL in Documentation/Makefile is for?  I\ndon't think a lower level fix is needed.\n"},{"id":"188631","messageId":"20120406054637.GA25301@sigill.intra.peff.net","threadId":"30158","inReplyTo":"20120406042215.GA3938@burratino","subject":"Re: Bad Man Page URLs","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2012-04-06T05:46:37Z","receivedAt":"2012-04-06T05:46:37Z","isPatch":false,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Thu, Apr 05, 2012 at 11:22:15PM -0500, Jonathan Nieder wrote:\n\n> Jeff King wrote:\n> \n> > So I think technically the docbook part of the toolchain would be the\n> > right place to fix this. But it may be easier to hack around it at the\n> > asciidoc level.\n> \n> Isn't this what MAN_BASE_URL in Documentation/Makefile is for?  I\n> don't think a lower level fix is needed.\n\nThanks for a dose of sanity. Having been here so long, I sometimes think\nthat if something exists in git, I would already know about it. But\nsometimes that is not true. :)\n\nJunio, what do you think of building the git-manpages-* tarballs (and\nthe git-manpages repo) with MAN_BASE_URL set to \"http://some-official-place/\"?\nAs of now, they mention \"file:///home/junio/...\".\n\nWe could need to have an official place, of course. I'd rather not use\nhttp://schacon.github.com/git/docs because these links will be embedded\nin release tarballs. Maybe it is time to make http://git-scm.com/docs\nhappen.\n\n-Peff\n"},{"id":"188634","messageId":"20120406061717.GB3911@burratino","threadId":"30158","inReplyTo":"20120406054637.GA25301@sigill.intra.peff.net","subject":"Re: Bad Man Page URLs","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2012-04-06T06:17:17Z","receivedAt":"2012-04-06T06:17:17Z","isPatch":false,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Jeff King wrote:\n\n> Junio, what do you think of building the git-manpages-* tarballs (and\n> the git-manpages repo) with MAN_BASE_URL set to \"http://some-official-place/\"?\n> As of now, they mention \"file:///home/junio/...\".\n\nCould be as simple as this, no?\n\nSigned-off-by: Jonathan Nieder <jrnieder@gmail.com>\n---\n Documentation/Makefile |   10 ++++++++--\n Makefile               |    1 +\n 2 files changed, 9 insertions(+), 2 deletions(-)\n\ndiff --git i/Documentation/Makefile w/Documentation/Makefile\nindex d40e211f..0edad3a2 100644\n--- i/Documentation/Makefile\n+++ w/Documentation/Makefile\n@@ -248,8 +248,14 @@ $(MAN_HTML): %.html : %.txt\n \t\t$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \\\n \tmv $@+ $@\n \n-manpage-base-url.xsl: manpage-base-url.xsl.in\n-\tsed \"s|@@MAN_BASE_URL@@|$(MAN_BASE_URL)|\" $< > $@\n+manpage-base-url.xsl: manpage-base-url.xsl.in FORCE\n+\t$(QUIET_GEN)$(RM) $@+ && \\\n+\tsed \"s|@@MAN_BASE_URL@@|$(MAN_BASE_URL)|\" $< > $@+ && \\\n+\tif test -e $@ && cmp -s $@+ $@; then \\\n+\t\t$(RM) $@+; \\\n+\telse \\\n+\t\tmv $@+ $@; \\\n+\tfi\n \n %.1 %.5 %.7 : %.xml manpage-base-url.xsl\n \t$(QUIET_XMLTO)$(RM) $@ && \\\ndiff --git i/Makefile w/Makefile\nindex be1957a5..ce6f805c 100644\n--- i/Makefile\n+++ w/Makefile\n@@ -2623,6 +2623,7 @@ dist-doc:\n \t$(RM) -r .doc-tmp-dir\n \tmkdir -p .doc-tmp-dir/man1 .doc-tmp-dir/man5 .doc-tmp-dir/man7\n \t$(MAKE) -C Documentation DESTDIR=./ \\\n+\t\tMAN_BASE_URL=git-htmldocs/ \\\n \t\tman1dir=../.doc-tmp-dir/man1 \\\n \t\tman5dir=../.doc-tmp-dir/man5 \\\n \t\tman7dir=../.doc-tmp-dir/man7 \\\n-- \n"},{"id":"188638","messageId":"7vzkap1gck.fsf@alter.siamese.dyndns.org","threadId":"30158","inReplyTo":"20120406054637.GA25301@sigill.intra.peff.net","subject":"Re: Bad Man Page URLs","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2012-04-06T07:15:07Z","receivedAt":"2012-04-06T07:15:07Z","isPatch":false,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jeff King <peff@peff.net> writes:\n\n> Junio, what do you think of building the git-manpages-* tarballs (and\n> the git-manpages repo) with MAN_BASE_URL set to \"http://some-official-place/\"?\n> As of now, they mention \"file:///home/junio/...\".\n\nI think git-manpages repo already sets the base to the old k.org location\n(see dodoc.sh in the 'todo' branch), but I forgot about that setting when\nI cobbled together the tarball releasing script to be run on my home box\nin a hurry. The releases used to be cut on a k.org machine and I initially\nplanned to stop generating the manpage/html tarballs when we lost shell\naccess to it, but some distro people demanded it, so...\n\nI do not know how well things would behave if we set it to \"git-htmldocs/\"\nas Jonathan suggests, but we will see what happens.\n\nI think there is no need to patch any Makefile; the make variable is\ndesigned to be overridable by the callers of make, so patches should go to\neither 'dodoc.sh' or the tarball release scripts, which are not checked in\nto the 'todo' branch yet, but I will do so if I remember ;-).\n\nFWIW, here is the (updated) 'RelBuild' script.\n\n-- >8 --\n#!/bin/sh\n\nversion=$(git describe --exact) &&\nlabel=$(echo \"$version\" | sed -e 's|^v||') &&\nversion=$(echo \"$label\" | sed -e 's|-|.|g') || exit\n\nmake clean && make dist &&\n\nASCIIDOC_NO_ROFF=YesPlease \\\nASCIIDOC8=YesPlease \\\nMAN_BASE_URL=\"git-htmldocs/\" \\\nmake dist-doc || exit\n\n# The above used to be\n# MAN_BASE_URL=\"http://www.kernel.org/pub/software/scm/git/docs/\"\n\nfiles=\"\n\tgit-$version.tar.gz\n\tgit-htmldocs-$version.tar.gz\n\tgit-manpages-$version.tar.gz\n\"\n\nfor file in $files\ndo\n\ttest -f $file || exit\ndone\n\nsha1sum $files | gpg --clearsign >git-$version.sign\n\nls -l git-$version.sign $files\n"},{"id":"188639","messageId":"20120406072349.GA27115@sigill.intra.peff.net","threadId":"30158","inReplyTo":"7vzkap1gck.fsf@alter.siamese.dyndns.org","subject":"Re: Bad Man Page URLs","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2012-04-06T07:23:49Z","receivedAt":"2012-04-06T07:23:49Z","isPatch":false,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Fri, Apr 06, 2012 at 12:15:07AM -0700, Junio C Hamano wrote:\n\n> > Junio, what do you think of building the git-manpages-* tarballs (and\n> > the git-manpages repo) with MAN_BASE_URL set to \"http://some-official-place/\"?\n> > As of now, they mention \"file:///home/junio/...\".\n> \n> I think git-manpages repo already sets the base to the old k.org location\n> (see dodoc.sh in the 'todo' branch), but I forgot about that setting when\n> I cobbled together the tarball releasing script to be run on my home box\n> in a hurry.\n\nAh, I didn't notice that. The k.org location is dead, of course, but I\nhope we will eventually turn it into at least a redirect to the official\nlocation.\n\nScott, I know you've been working hard on the git-scm.com redesign. Any\nword on when that will be ready, or whether it will contain a mirror of\nthe reference docs?\n\n> I do not know how well things would behave if we set it to \"git-htmldocs/\"\n> as Jonathan suggests, but we will see what happens.\n\nUsers will see reference to \"git-htmldocs/everyday.html\" in their\nmanpage. Not quite as nice as a real URL, but at least not entirely\nmisleading.\n\n-Peff\n"},{"id":"190147","messageId":"BCD7B631-8C73-4F3F-AB37-9B5CF02655D5@justatheory.com","threadId":"30158","inReplyTo":"7vzkap1gck.fsf@alter.siamese.dyndns.org","subject":"Re: Bad Man Page URLs","fromName":"David E. Wheeler","fromEmail":"david@justatheory.com","sentAt":"2012-04-26T20:12:38Z","receivedAt":"2012-04-26T20:12:38Z","isPatch":false,"sender":{"key":"david@justatheory.com","avatar":"https://gravatar.com/avatar/17283ea1e4276cc8e69df64f9c5c731fa97d480f97694231f43384e186bdcd90?d=mp&s=160"},"body":"On Apr 6, 2012, at 12:15 AM, Junio C Hamano wrote:\n\n>> Junio, what do you think of building the git-manpages-* tarballs (and\n>> the git-manpages repo) with MAN_BASE_URL set to \"http://some-official-place/\"?\n>> As of now, they mention \"file:///home/junio/...\".\n> \n> I think git-manpages repo already sets the base to the old k.org location\n> (see dodoc.sh in the 'todo' branch), but I forgot about that setting when\n> I cobbled together the tarball releasing script to be run on my home box\n> in a hurry. The releases used to be cut on a k.org machine and I initially\n> planned to stop generating the manpage/html tarballs when we lost shell\n> access to it, but some distro people demanded it, so...\n> \n> I do not know how well things would behave if we set it to \"git-htmldocs/\"\n> as Jonathan suggests, but we will see what happens.\n> \n> I think there is no need to patch any Makefile; the make variable is\n> designed to be overridable by the callers of make, so patches should go to\n> either 'dodoc.sh' or the tarball release scripts, which are not checked in\n> to the 'todo' branch yet, but I will do so if I remember ;-).\n> \n> FWIW, here is the (updated) 'RelBuild' script.\n\nDon't know if you've applied this fix, but I just downloaded the 1.7.10 man pages, and they URLs are now:\n\n        1. Everyday Git\n           git-htmldocs/everyday.html\n\n        2. Git User's Manual\n           git-htmldocs/user-manual.html\n\n        3. git concepts chapter of the user-manual\n           git-htmldocs/user-manual.html#git-concepts\n\n        4. howto\n           git-htmldocs/howto-index.html\n\n        5. GIT API documentation\n           git-htmldocs/technical/api-index.html\n\nWhich also aren't very useful. :-(\n\nDavid\n"},{"id":"190149","messageId":"20120426201921.GA15026@burratino","threadId":"30158","inReplyTo":"BCD7B631-8C73-4F3F-AB37-9B5CF02655D5@justatheory.com","subject":"Re: Bad Man Page URLs","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2012-04-26T20:19:22Z","receivedAt":"2012-04-26T20:19:22Z","isPatch":false,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"David E. Wheeler wrote:\n\n>         5. GIT API documentation\n>            git-htmldocs/technical/api-index.html\n>\n> Which also aren't very useful. :-(\n\nSure they are --- they tell you where in the git-htmldocs tarball\nfrom [1] to find the relevant pages.\n\nDo you know of a public webpage we can count on to continue to serve\nthe docs?  I agree that that would be even better.\n\nHope that helps,\nJonathan\n\n[1] http://code.google.com/p/git-core/downloads/list\n"},{"id":"190150","messageId":"0DF25EFA-9CB5-4CA3-B654-D796175220F7@justatheory.com","threadId":"30158","inReplyTo":"20120426201921.GA15026@burratino","subject":"Re: Bad Man Page URLs","fromName":"David E. Wheeler","fromEmail":"david@justatheory.com","sentAt":"2012-04-26T20:24:35Z","receivedAt":"2012-04-26T20:24:35Z","isPatch":false,"sender":{"key":"david@justatheory.com","avatar":"https://gravatar.com/avatar/17283ea1e4276cc8e69df64f9c5c731fa97d480f97694231f43384e186bdcd90?d=mp&s=160"},"body":"On Apr 26, 2012, at 1:19 PM, Jonathan Nieder wrote:\n\n> Sure they are --- they tell you where in the git-htmldocs tarball\n> from [1] to find the relevant pages.\n> \n> Do you know of a public webpage we can count on to continue to serve\n> the docs?  I agree that that would be even better.\n\nAll of those titles have links on gitmanual.org:\n\n  http://www.gitmanual.org/\n\nAlthough it looks like the “GIT API documentation” link is broken (404).\n\nBest,\n\nDavid\n"},{"id":"190151","messageId":"20120426202909.GA15385@burratino","threadId":"30158","inReplyTo":"0DF25EFA-9CB5-4CA3-B654-D796175220F7@justatheory.com","subject":"Re: Bad Man Page URLs","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2012-04-26T20:29:09Z","receivedAt":"2012-04-26T20:29:09Z","isPatch":false,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"David E. Wheeler wrote:\n> On Apr 26, 2012, at 1:19 PM, Jonathan Nieder wrote:\n\n>> Do you know of a public webpage we can count on to continue to serve\n>> the docs?  I agree that that would be even better.\n>\n> All of those titles have links on gitmanual.org:\n>\n>   http://www.gitmanual.org/\n\nWho runs that webpage?  Would they mind the increased traffic?  Can we\ncount on them to continue to serve the docs?\n"},{"id":"190153","messageId":"92D71232-83D3-4CC5-BC35-8F697070F8F7@justatheory.com","threadId":"30158","inReplyTo":"20120426202909.GA15385@burratino","subject":"Re: Bad Man Page URLs","fromName":"David E. Wheeler","fromEmail":"david@justatheory.com","sentAt":"2012-04-26T20:34:55Z","receivedAt":"2012-04-26T20:34:55Z","isPatch":false,"sender":{"key":"david@justatheory.com","avatar":"https://gravatar.com/avatar/17283ea1e4276cc8e69df64f9c5c731fa97d480f97694231f43384e186bdcd90?d=mp&s=160"},"body":"On Apr 26, 2012, at 1:29 PM, Jonathan Nieder wrote:\n\n>> All of those titles have links on gitmanual.org:\n>> \n>>  http://www.gitmanual.org/\n> \n> Who runs that webpage?  Would they mind the increased traffic?  Can we\n> count on them to continue to serve the docs?\n\nOh, not an official Git site? Seems to me that the project ought to have something like that. Many of the same links are on http://git-scm.com/documentation. As for gitmanual.org, whois says:\n\nRegistrant Name:Loic d'Anterroches\nRegistrant Organization:Ceondo Ltd\nRegistrant City:London\nRegistrant Email:pnwr10o0vs6u6a82ixx9@o.o-w-o.info\n\nBest,\n\nDavid\n"},{"id":"190156","messageId":"20120426210251.GA31589@sigill.intra.peff.net","threadId":"30158","inReplyTo":"20120426201921.GA15026@burratino","subject":"Re: Bad Man Page URLs","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2012-04-26T21:02:51Z","receivedAt":"2012-04-26T21:02:51Z","isPatch":false,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Thu, Apr 26, 2012 at 03:19:22PM -0500, Jonathan Nieder wrote:\n\n> David E. Wheeler wrote:\n> \n> >         5. GIT API documentation\n> >            git-htmldocs/technical/api-index.html\n> >\n> > Which also aren't very useful. :-(\n> \n> Sure they are --- they tell you where in the git-htmldocs tarball\n> from [1] to find the relevant pages.\n> \n> Do you know of a public webpage we can count on to continue to serve\n> the docs?  I agree that that would be even better.\n\nI think http://git-scm.com/ would be the ideal place. My understanding\nis that the re-work of the site is nearing completion. Scott, ETA?\n\n-Peff\n"},{"id":"190160","messageId":"CAP2yMa+mjvFmVwXjrB7FRaD2=iMCCPENWAOoCG5TCsqFdsCDxQ@mail.gmail.com","threadId":"30158","inReplyTo":"20120426210251.GA31589@sigill.intra.peff.net","subject":"Re: Bad Man Page URLs","fromName":"Scott Chacon","fromEmail":"schacon@gmail.com","sentAt":"2012-04-26T21:58:47Z","receivedAt":"2012-04-26T21:58:47Z","isPatch":false,"sender":{"key":"schacon@gmail.com","avatar":"https://gravatar.com/avatar/9b13a8a078e1dcf8588c4eea9554445d51ebed6c41b51f56f4d96738130b05c6?d=mp&s=160"},"body":"Hey,\n\nOn Thu, Apr 26, 2012 at 2:02 PM, Jeff King <peff@peff.net> wrote:\n>>\n>> Do you know of a public webpage we can count on to continue to serve\n>> the docs?  I agree that that would be even better.\n>\n> I think http://git-scm.com/ would be the ideal place. My understanding\n> is that the re-work of the site is nearing completion. Scott, ETA?\n\nYes, we are very close to launching a big redesign of git-scm.com.\nThe manpages will be automatically updated on that site, you can\ncertainly link to them there.\n\nIf you want to preview what it's going to look like and the URL\nstructure, you can check out the current working version here:\n\nhttp://git-scm.herokuapp.com/docs/git-fetch\n\nThere are a number of known bugs and I want to make it much faster\nbefore I officially launch it and redirect DNS, but you can get an\nidea of how it will be structured and what it will look like.  If you\nwant to start generating docs with static urls for man pages, they can\nbe of the form: http://git-scm.com/docs/git-command\n\nYou can also put a version number after them to permalink them at a\ncertain version:\n\nhttp://git-scm.herokuapp.com/docs/git-fetch/1.7.3.2\n\nWhen it's close to what I think is ready, I'll do a post to this list\nlooking for feedback and bugs, etc.\n\nScott\n\n>\n> -Peff\n"},{"id":"190161","messageId":"BEA084BA-739D-4D73-80C0-FE2FC1598D9F@justatheory.com","threadId":"30158","inReplyTo":"CAP2yMa+mjvFmVwXjrB7FRaD2=iMCCPENWAOoCG5TCsqFdsCDxQ@mail.gmail.com","subject":"Re: Bad Man Page URLs","fromName":"David E. Wheeler","fromEmail":"david@justatheory.com","sentAt":"2012-04-26T22:11:52Z","receivedAt":"2012-04-26T22:11:52Z","isPatch":false,"sender":{"key":"david@justatheory.com","avatar":"https://gravatar.com/avatar/17283ea1e4276cc8e69df64f9c5c731fa97d480f97694231f43384e186bdcd90?d=mp&s=160"},"body":"On Apr 26, 2012, at 2:58 PM, Scott Chacon wrote:\n\n> Yes, we are very close to launching a big redesign of git-scm.com.\n> The manpages will be automatically updated on that site, you can\n> certainly link to them there.\n> \n> If you want to preview what it's going to look like and the URL\n> structure, you can check out the current working version here:\n> \n> http://git-scm.herokuapp.com/docs/git-fetch\n\nWow, the new site looks *awesome*! :-)\n\n> There are a number of known bugs and I want to make it much faster\n> before I officially launch it and redirect DNS, but you can get an\n> idea of how it will be structured and what it will look like.  If you\n> want to start generating docs with static urls for man pages, they can\n> be of the form: http://git-scm.com/docs/git-command\n> \n> You can also put a version number after them to permalink them at a\n> certain version:\n> \n> http://git-scm.herokuapp.com/docs/git-fetch/1.7.3.2\n\nVery nice. I only found one of the links from the manpage there, though:\n\n  Everyday Git\n  http://git-scm.herokuapp.com/docs/everyday.html\n\nHere are the others on gitmanual.org (maybe I just couldn't find them on the new site?):\n\n  User Manual\n  http://www.gitmanual.org/user-manual.html\n\n  git concepts chapter of the user-manual\n  http://www.gitmanual.org/user-manual.html#git-concepts\n\n  howto\n  http://www.gitmanual.org/howto-index.html\n\nAnd this one is a broken link on gitmanual.org and other places on the internetz.\n\n  GIT API documentation\n  ????\n\nBest,\n\nDavid\n"},{"id":"190162","messageId":"20120426221259.GA16192@burratino","threadId":"30158","inReplyTo":"CAP2yMa+mjvFmVwXjrB7FRaD2=iMCCPENWAOoCG5TCsqFdsCDxQ@mail.gmail.com","subject":"Re: Bad Man Page URLs","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2012-04-26T22:12:59Z","receivedAt":"2012-04-26T22:12:59Z","isPatch":false,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Scott Chacon wrote:\n> On Thu, Apr 26, 2012 at 2:02 PM, Jeff King <peff@peff.net> wrote:\n\n>>> Do you know of a public webpage we can count on to continue to serve\n>>> the docs?  I agree that that would be even better.\n>>\n>> I think http://git-scm.com/ would be the ideal place. My understanding\n>> is that the re-work of the site is nearing completion. Scott, ETA?\n[...]\n> If you want to preview what it's going to look like and the URL\n> structure, you can check out the current working version here:\n>\n> http://git-scm.herokuapp.com/docs/git-fetch\n\nIs it intended to include documents such as \"technical/api-credentials\"?\nI ask because David was looking for some permanent place for the\nreferences section of pages like gitcredentials(7) to link to.\n\nCurious,\nJonathan\n"},{"id":"190163","messageId":"xmqqehra6swg.fsf@junio.mtv.corp.google.com","threadId":"30158","inReplyTo":"CAP2yMa+mjvFmVwXjrB7FRaD2=iMCCPENWAOoCG5TCsqFdsCDxQ@mail.gmail.com","subject":"Re: Bad Man Page URLs","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2012-04-26T22:16:15Z","receivedAt":"2012-04-26T22:16:15Z","isPatch":false,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Scott Chacon <schacon@gmail.com> writes:\n\n> If you want to preview what it's going to look like and the URL\n> structure, you can check out the current working version here:\n>\n> http://git-scm.herokuapp.com/docs/git-fetch\n\nNicely done.\n\nIs it possible to have a link to Release Notes (not manual pages, which\nyou already have links to) for each release from \"http://site/docs/git\"\nlike we used to have at k.org site?  It is not a big deal, but that is\none thing I miss the most.\n"},{"id":"190164","messageId":"CAP2yMaKiAT-YJeqmxzZeVuNhEnN-LaJ2h3fSuzZbonKyxCKCCw@mail.gmail.com","threadId":"30158","inReplyTo":"xmqqehra6swg.fsf@junio.mtv.corp.google.com","subject":"Re: Bad Man Page URLs","fromName":"Scott Chacon","fromEmail":"schacon@gmail.com","sentAt":"2012-04-26T22:25:11Z","receivedAt":"2012-04-26T22:25:11Z","isPatch":false,"sender":{"key":"schacon@gmail.com","avatar":"https://gravatar.com/avatar/9b13a8a078e1dcf8588c4eea9554445d51ebed6c41b51f56f4d96738130b05c6?d=mp&s=160"},"body":"On Thu, Apr 26, 2012 at 3:16 PM, Junio C Hamano <gitster@pobox.com> wrote:\n> Is it possible to have a link to Release Notes (not manual pages, which\n> you already have links to) for each release from \"http://site/docs/git\"\n> like we used to have at k.org site?  It is not a big deal, but that is\n> one thing I miss the most.\n\nYes, this is pretty easy to do - just about everything in\nDocumentation/ will eventually be rendered - including the user-manual\nthat is currently missing and the release notes.\n\nScott\n"},{"id":"190185","messageId":"20120426223453.GB16192@burratino","threadId":"30158","inReplyTo":"CAP2yMaKiAT-YJeqmxzZeVuNhEnN-LaJ2h3fSuzZbonKyxCKCCw@mail.gmail.com","subject":"Re: Bad Man Page URLs","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2012-04-26T22:34:53Z","receivedAt":"2012-04-26T22:34:53Z","isPatch":false,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Scott Chacon wrote:\n\n> Yes, this is pretty easy to do - just about everything in\n> Documentation/ will eventually be rendered - including the user-manual\n> that is currently missing and the release notes.\n\nNice. :)  Thanks much for doing this.\n\nIt seems from adaa3caf that to add the links to release notes, the\nappropriate incantation is ASCIIDOC_EXTRA='-a stalenotes'.\n\nJonathan\n"},{"id":"190599","messageId":"m3lilaqmub.fsf@localhost.localdomain","threadId":"30158","inReplyTo":"92D71232-83D3-4CC5-BC35-8F697070F8F7@justatheory.com","subject":"Re: Bad Man Page URLs","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2012-05-02T21:46:02Z","receivedAt":"2012-05-02T21:46:02Z","isPatch":false,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"\"David E. Wheeler\" <david@justatheory.com> writes:\n> On Apr 26, 2012, at 1:29 PM, Jonathan Nieder wrote:\n>>> \n>>> All of those titles have links on gitmanual.org:\n>>> \n>>>  http://www.gitmanual.org/\n>> \n>> Who runs that webpage?  Would they mind the increased traffic?  Can we\n>> count on them to continue to serve the docs?\n> \n> Oh, not an official Git site? Seems to me that the project ought to\n> have something like that. Many of the same links are on\n> http://git-scm.com/documentation.\n>\n> As for gitmanual.org, whois says:\n> \n> Registrant Name:Loic d'Anterroches\n> Registrant Organization:Ceondo Ltd\n> Registrant City:London\n> Registrant Email:pnwr10o0vs6u6a82ixx9@o.o-w-o.info\n\nIf I am not mistaken this is the person behind InDefero git hosting\nsite (http://www.indefero.net) and git hosting software powering it\n(http://projects.ceondo.com/p/indefero) in PHP.\n\nI don't remember it being announced on git mailing list...\n\n-- \nJakub Narebski\n"}]}