{"thread":{"id":"42685","subject":"[PATCH] doc: git-htmldocs.googlecode.com is no more","startedAt":"2016-06-22T03:39:44Z","lastAt":"2016-06-28T18:03:52Z","messageCount":10,"participants":["Jonathan Nieder","Junio C Hamano","Eric Wong","Jeff King","Matthieu Moy"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"289823","messageId":"20160622024151.GA20206@google.com","threadId":"42685","inReplyTo":"146652690896.29270.13813898006180324611.reportbug@duelitri","subject":"[PATCH] doc: git-htmldocs.googlecode.com is no more","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2016-06-22T02:41:52Z","receivedAt":"2016-06-22T03:39:44Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"http://git-htmldocs.googlecode.com/git/git.html says\n\n There was no service found for the uri requested.\n\nLink to the HTML documentation on repo.or.cz instead.\n\nI'd rather use an up-to-date https link for the rendered\ndocumentation, but I wasn't able to find one. According to the 'todo'\nbranch, prebuilt documentation is pushed to\n\n 1. https://kernel.googlesource.com/pub/scm/git/git-htmldocs\n 2. git://repo.or.cz/git-htmldocs\n 3. somewhere on git.sourceforge.jp and git.sourceforge.net?\n 4. https://github.com/gitster/git-htmldocs\n 5. https://github.com/git/htmldocs\n\nOf these, (1) and (4) don't provide a raw view with content-type\ntext/html. (5) might be available as HTML through Jekyll, but I\nwasn't able to find it --- e.g., https://git.github.io/htmldocs does\nnot show those pages. I wasn't able to find (3) at all. That leaves\n(2).\n\nReported-by: Andrea Stacchiotti \nSigned-off-by: Jonathan Nieder \n---\nHi Andrea,\n\nAndrea Stacchiotti wrote[1]:\n\n> In the git manual (`man git`), the documentation link:\n> > http://git-htmldocs.googlecode.com/git/git.html\n> is broken.\n\nThanks for reporting. How about this patch?\n\nThanks,\nJonathan\n\n[1] http://bugs.debian.org/827844\n\n-- >8 --\nSubject: doc: git-htmldocs.googlecode.com is no more\n\n Documentation/git.txt | 4 ++--\n 1 file changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex 5490d3c..de923db 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -31,8 +31,8 @@ page to learn what commands Git offers. You can learn more about\n individual Git commands with \"git help command\". linkgit:gitcli[7]\n manual page gives you an overview of the command-line command syntax.\n \n-Formatted and hyperlinked version of the latest Git documentation\n-can be viewed at `http://git-htmldocs.googlecode.com/git/git.html`.\n+A formatted and hyperlinked copy of the latest Git documentation\n+can be viewed at `http://repo.or.cz/git-htmldocs.git/blob_plain/:/git.html`.\n \n ifdef::stalenotes[]\n [NOTE]\n-- \n"},{"id":"289870","messageId":"xmqq60t1noon.fsf@gitster.mtv.corp.google.com","threadId":"42685","inReplyTo":"20160622024151.GA20206@google.com","subject":"Re: [PATCH] doc: git-htmldocs.googlecode.com is no more","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2016-06-22T17:00:56Z","receivedAt":"2016-06-22T17:01:05Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jonathan Nieder writes:\n\n> http://git-htmldocs.googlecode.com/git/git.html says\n>\n> There was no service found for the uri requested.\n>\n> Link to the HTML documentation on repo.or.cz instead.\n\nhttp://thread.gmane.org/gmane.comp.version-control.git/296483/focus=296575\n\nPeff suggested to use the github pages that are connected to the\n\"git\" org, and helped its initial set-up. When I update the\nprebuilt docs, in addition to the listed locations, I also push to\nthe gh-pages branch of https://github.com/git/htmldocs repository\nand the result appears in https://git.github.io/htmldocs/git.html\n\nEven though we do have index.html -> git.html, gh-pages does not\nseem to let you follow it, so you need to start from git.html, and I\nsuspect that it is why the below says \"I wasn't able to find it\" for\n(5).\n\nSo perhaps list both? I do not know how beefy repo.or.cz is, or how\nwell connected it is to the rest of the world, but if I have to pick\nonly one, I'd feel safer if we didn't have to exploit the \"blob_plain/:\"\nbackdoor.\n\nThanks.\n\n> I'd rather use an up-to-date https link for the rendered\n> documentation, but I wasn't able to find one. According to the 'todo'\n> branch, prebuilt documentation is pushed to\n>\n> 1. https://kernel.googlesource.com/pub/scm/git/git-htmldocs\n> 2. git://repo.or.cz/git-htmldocs\n> 3. somewhere on git.sourceforge.jp and git.sourceforge.net?\n> 4. https://github.com/gitster/git-htmldocs\n> 5. https://github.com/git/htmldocs\n>\n> Of these, (1) and (4) don't provide a raw view with content-type\n> text/html. (5) might be available as HTML through Jekyll, but I\n> wasn't able to find it --- e.g., https://git.github.io/htmldocs does\n> not show those pages. I wasn't able to find (3) at all. That leaves\n> (2).\n>\n> Reported-by: Andrea Stacchiotti \n> Signed-off-by: Jonathan Nieder \n> ---\n> Hi Andrea,\n>\n> Andrea Stacchiotti wrote[1]:\n>\n>> In the git manual (`man git`), the documentation link:\n>> > http://git-htmldocs.googlecode.com/git/git.html\n>> is broken.\n>\n> Thanks for reporting. How about this patch?\n>\n> Thanks,\n> Jonathan\n>\n> [1] http://bugs.debian.org/827844\n>\n> -- >8 --\n> Subject: doc: git-htmldocs.googlecode.com is no more\n>\n> Documentation/git.txt | 4 ++--\n> 1 file changed, 2 insertions(+), 2 deletions(-)\n>\n> diff --git a/Documentation/git.txt b/Documentation/git.txt\n> index 5490d3c..de923db 100644\n> --- a/Documentation/git.txt\n> +++ b/Documentation/git.txt\n> @@ -31,8 +31,8 @@ page to learn what commands Git offers. You can learn more about\n> individual Git commands with \"git help command\". linkgit:gitcli[7]\n> manual page gives you an overview of the command-line command syntax.\n> \n> -Formatted and hyperlinked version of the latest Git documentation\n> -can be viewed at `http://git-htmldocs.googlecode.com/git/git.html`.\n> +A formatted and hyperlinked copy of the latest Git documentation\n> +can be viewed at `http://repo.or.cz/git-htmldocs.git/blob_plain/:/git.html`.\n> \n> ifdef::stalenotes[]\n> [NOTE]\n"},{"id":"289875","messageId":"20160622173825.GD20206@google.com","threadId":"42685","inReplyTo":"xmqq60t1noon.fsf@gitster.mtv.corp.google.com","subject":"[PATCH v2] doc: git-htmldocs.googlecode.com is no more","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2016-06-22T17:38:25Z","receivedAt":"2016-06-22T17:38:33Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"http://git-htmldocs.googlecode.com/git/git.html says\n\n There was no service found for the uri requested.\n\nLink to the rendered documentation on Jekyll instead.\n\nReported-by: Andrea Stacchiotti \nSigned-off-by: Jonathan Nieder \n---\nJunio C Hamano wrote:\n\n> Even though we do have index.html -> git.html, gh-pages does not\n> seem to let you follow it, so you need to start from git.html, and I\n> suspect that it is why the below says \"I wasn't able to find it\" for\n> (5).\n\nYup, that explains it.\n\n> So perhaps list both? I do not know how beefy repo.or.cz is, or how\n> well connected it is to the rest of the world, but if I have to pick\n> only one, I'd feel safer if we didn't have to exploit the \"blob_plain/:\"\n> backdoor.\n\nThere's only one option that uses https, so let's just use that one.\n\nThanks for the pointers.\n\nJonathan\n\n Documentation/git.txt | 4 ++--\n 1 file changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex 5490d3c..0fb14f1 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -31,8 +31,8 @@ page to learn what commands Git offers. You can learn more about\n individual Git commands with \"git help command\". linkgit:gitcli[7]\n manual page gives you an overview of the command-line command syntax.\n \n-Formatted and hyperlinked version of the latest Git documentation\n-can be viewed at `http://git-htmldocs.googlecode.com/git/git.html`.\n+A formatted and hyperlinked copy of the latest Git documentation\n+can be viewed at `https://git.github.io/htmldocs/git.html`.\n \n ifdef::stalenotes[]\n [NOTE]\n-- \n"},{"id":"289886","messageId":"20160622190018.GA786@dcvr.yhbt.net","threadId":"42685","inReplyTo":"20160622024151.GA20206@google.com","subject":"Re: [PATCH] doc: git-htmldocs.googlecode.com is no more","fromName":"Eric Wong","fromEmail":"e@80x24.org","sentAt":"2016-06-22T19:00:18Z","receivedAt":"2016-06-22T19:00:42Z","isPatch":true,"sender":{"key":"e@80x24.org","avatar":null},"body":"Jonathan Nieder wrote:\n> I'd rather use an up-to-date https link for the rendered\n> documentation, but I wasn't able to find one. According to the 'todo'\n> branch, prebuilt documentation is pushed to\n> \n> 1. https://kernel.googlesource.com/pub/scm/git/git-htmldocs\n> 2. git://repo.or.cz/git-htmldocs\n> 3. somewhere on git.sourceforge.jp and git.sourceforge.net?\n> 4. https://github.com/gitster/git-htmldocs\n> 5. https://github.com/git/htmldocs\n\nJust wondering, who updates\nhttps://kernel.org/pub/software/scm/git/docs/\nand why hasn't it been updated in a while?\n(currently it says Last updated 2015-06-06 at the bottom)\n\nI normally link people there since I would rather not advertise\nfor a commercial service.\n"},{"id":"289888","messageId":"CAPc5daUiUv-EEv7ouQ=K+Q8S64QVV5wn4H6+TuF0wLeo123K5Q@mail.gmail.com","threadId":"42685","inReplyTo":"20160622190018.GA786@dcvr.yhbt.net","subject":"Re: [PATCH] doc: git-htmldocs.googlecode.com is no more","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2016-06-22T19:02:18Z","receivedAt":"2016-06-22T19:02:46Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"On Wed, Jun 22, 2016 at 12:00 PM, Eric Wong wrote:\n>\n> Just wondering, who updates\n> https://kernel.org/pub/software/scm/git/docs/\n> and why hasn't it been updated in a while?\n> (currently it says Last updated 2015-06-06 at the bottom)\n\nNobody. It is too cumbersome to use their upload tool to update many\nfiles (it is geared towards updating a handful of tarballs at a time).\n"},{"id":"289896","messageId":"20160622200607.GD1697@sigill.intra.peff.net","threadId":"42685","inReplyTo":"xmqq60t1noon.fsf@gitster.mtv.corp.google.com","subject":"Re: [PATCH] doc: git-htmldocs.googlecode.com is no more","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2016-06-22T20:06:08Z","receivedAt":"2016-06-22T20:06:13Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Wed, Jun 22, 2016 at 10:00:56AM -0700, Junio C Hamano wrote:\n\n> Peff suggested to use the github pages that are connected to the\n> \"git\" org, and helped its initial set-up. When I update the\n> prebuilt docs, in addition to the listed locations, I also push to\n> the gh-pages branch of https://github.com/git/htmldocs repository\n> and the result appears in https://git.github.io/htmldocs/git.html\n> \n> Even though we do have index.html -> git.html, gh-pages does not\n> seem to let you follow it, so you need to start from git.html, and I\n> suspect that it is why the below says \"I wasn't able to find it\" for\n> (5).\n\nYeah, I looked into this a little back then, and I think it is simply\nthat the Pages builder does not handle symlinks at all. You could push\nout index.html as a true copy rather than a symlink, but I think just\npointing to \"git.html\" as the entry page of the site is reasonable, too\n(we could even make index.html a true overview page later if we want).\n\n> So perhaps list both? I do not know how beefy repo.or.cz is, or how\n> well connected it is to the rest of the world, but if I have to pick\n> only one, I'd feel safer if we didn't have to exploit the \"blob_plain/:\"\n> backdoor.\n\nBeefiness aside, the GitHub version will be served out of a CDN, which\nmeans it should perform way better for the user, as it will often get\nserved from a geographically local cache.\n\n-Peff\n"},{"id":"289931","messageId":"20160622214811.GA19633@dcvr.yhbt.net","threadId":"42685","inReplyTo":"CAPc5daUiUv-EEv7ouQ=K+Q8S64QVV5wn4H6+TuF0wLeo123K5Q@mail.gmail.com","subject":"Re: [PATCH] doc: git-htmldocs.googlecode.com is no more","fromName":"Eric Wong","fromEmail":"e@80x24.org","sentAt":"2016-06-22T21:48:11Z","receivedAt":"2016-06-22T21:48:15Z","isPatch":true,"sender":{"key":"e@80x24.org","avatar":null},"body":"Junio C Hamano wrote:\n> On Wed, Jun 22, 2016 at 12:00 PM, Eric Wong wrote:\n> >\n> > Just wondering, who updates\n> > https://kernel.org/pub/software/scm/git/docs/\n> > and why hasn't it been updated in a while?\n> > (currently it says Last updated 2015-06-06 at the bottom)\n> \n> Nobody. It is too cumbersome to use their upload tool to update many\n> files (it is geared towards updating a handful of tarballs at a time).\n\nAlright, I've setup https://git-htmldocs.bogomips.org/ for my own\nusage, at least. It should check for updates twice an hour(*),\nand plain HTTP is also available in case Let's Encrypt goes away.\n\nCan't hurt to have more mirrors:\n----------------------8<---------------------\n#!/bin/sh\nset -e\nDST=/path/to/server-docroot/git-htmldocs\n# my mirror of git://git.kernel.org/pub/scm/git/git-htmldocs.git:\nGIT_DIR=/path/to/mirrors/git-htmldocs.git\nexport GIT_DIR\n\n# rsync from a temporary dir for atomicity so nobody fetches\n# a partially written file\ntmp=\"$(mktemp -t -d htmldocs.XXXXXXX)\"\ngit archive --format=tar HEAD | tar x -C \"$tmp\"\nchmod 755 \"$tmp\"\nrsync -a \"$tmp/\" \"$DST/\"\nrm -rf \"$tmp\"\n\n# for servers which support pre-gzipped files (e.g. gzip_static in nginx)\nfind \"$DST\" -type f -name '*.html' -o -name '*.txt' | while read file\ndo\n\tgz=\"$file.gz\"\n\tif ! test -e \"$gz\" || test \"$gz\" -ot \"$file\"\n\tthen\n\t\tgztmp=\"$gz.$$.tmp\"\n\t\tgzip -9 <\"$file\" >\"$gztmp\"\n\t\ttouch -r \"$file\" \"$gztmp\"\n\t\tmv \"$gztmp\" \"$gz\"\n\tfi\ndone\n---\n(*) On a side note, It would be nice to something like IMAP IDLE\n for real-time updates of mirrors.\n"},{"id":"289944","messageId":"vpq8txwtmg8.fsf@anie.imag.fr","threadId":"42685","inReplyTo":"CAPc5daUiUv-EEv7ouQ=K+Q8S64QVV5wn4H6+TuF0wLeo123K5Q@mail.gmail.com","subject":"Re: [PATCH] doc: git-htmldocs.googlecode.com is no more","fromName":"Matthieu Moy","fromEmail":"matthieu.moy@grenoble-inp.fr","sentAt":"2016-06-23T07:04:55Z","receivedAt":"2016-06-23T07:05:27Z","isPatch":true,"sender":{"key":"matthieu.moy@grenoble-inp.fr","avatar":"https://gravatar.com/avatar/72c8a2705971a25dfaff23cece15130d405685845d911aedd5667ace277f3fc5?d=mp&s=160"},"body":"Junio C Hamano writes:\n\n> On Wed, Jun 22, 2016 at 12:00 PM, Eric Wong wrote:\n>>\n>> Just wondering, who updates\n>> https://kernel.org/pub/software/scm/git/docs/\n>> and why hasn't it been updated in a while?\n>> (currently it says Last updated 2015-06-06 at the bottom)\n>\n> Nobody. It is too cumbersome to use their upload tool to update many\n> files (it is geared towards updating a handful of tarballs at a time).\n\nThen, I guess it would make sense to remove it to avoid pointing users\nto outdated docs?\n\n-- \nMatthieu Moy\nhttp://www-verimag.imag.fr/~moy/\n"},{"id":"290052","messageId":"xmqqbn2qfjw6.fsf@gitster.mtv.corp.google.com","threadId":"42685","inReplyTo":"vpq8txwtmg8.fsf@anie.imag.fr","subject":"Re: [PATCH] doc: git-htmldocs.googlecode.com is no more","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2016-06-24T19:48:25Z","receivedAt":"2016-06-24T20:02:08Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Matthieu Moy writes:\n\n> Junio C Hamano writes:\n>\n>> On Wed, Jun 22, 2016 at 12:00 PM, Eric Wong wrote:\n>>>\n>>> Just wondering, who updates\n>>> https://kernel.org/pub/software/scm/git/docs/\n>>> and why hasn't it been updated in a while?\n>>> (currently it says Last updated 2015-06-06 at the bottom)\n>>\n>> Nobody. It is too cumbersome to use their upload tool to update many\n>> files (it is geared towards updating a handful of tarballs at a time).\n>\n> Then, I guess it would make sense to remove it to avoid pointing users\n> to outdated docs?\n\nI'll see what I can do at k.org these days.\n\nDon't hold your breath, don't stay tuned, but don't be surprised if\nyou see a positive change in the future ;-)\n\nThanks.\n"},{"id":"290407","messageId":"xmqqpor18a2n.fsf@gitster.mtv.corp.google.com","threadId":"42685","inReplyTo":"vpq8txwtmg8.fsf@anie.imag.fr","subject":"Re: [PATCH] doc: git-htmldocs.googlecode.com is no more","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2016-06-28T18:03:44Z","receivedAt":"2016-06-28T18:03:52Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Matthieu Moy writes:\n\n> Junio C Hamano writes:\n>\n>> On Wed, Jun 22, 2016 at 12:00 PM, Eric Wong wrote:\n>>>\n>>> Just wondering, who updates\n>>> https://kernel.org/pub/software/scm/git/docs/\n>>> and why hasn't it been updated in a while?\n>>> (currently it says Last updated 2015-06-06 at the bottom)\n>>\n>> Nobody. It is too cumbersome to use their upload tool to update many\n>> files (it is geared towards updating a handful of tarballs at a time).\n>\n> Then, I guess it would make sense to remove it to avoid pointing users\n> to outdated docs?\n\nActually, it turns out that k.org folks have an auto-builder that\nupdates the documentation set for each release. It hasn't been run\nsince v2.5 days, though, until very recently.\n\nI was told that the above URL currently should be showing v2.9.0\ndocs.\n\nThe rule for https://kernel.org/pub/software/scm/git/docs/ currently\nis that it shows documentation set for a released, but this is\nlikely to change in the future (s/a released/the latest release/ at\nthe minimum, with some definition of \"the latest\").\n\nAlso https://kernel.org/pub/software/scm/git/docs/v2.4.0/git.html\nwould give you the documentation set for that version.\n"}]}