patchdoc: git-htmldocs.googlecode.com is no more

http://git-htmldocs.googlecode.com/git/git.html says

 There was no service found for the uri requested.

Link to the HTML documentation on repo.or.cz instead.

I'd rather use an up-to-date https link for the rendered documentation, but I wasn't able to find one. According to the 'todo' branch, prebuilt documentation is pushed to

 1. https://kernel.googlesource.com/pub/scm/git/git-htmldocs
 2. git://repo.or.cz/git-htmldocs
 3. somewhere on git.sourceforge.jp and git.sourceforge.net?
 4. https://github.com/gitster/git-htmldocs
 5. https://github.com/git/htmldocs

Of these, (1) and (4) don't provide a raw view with content-type text/html. (5) might be available as HTML through Jekyll, but I wasn't able to find it --- e.g., https://git.github.io/htmldocs does not show those pages. I wasn't able to find (3) at all. That leaves (2).

Reported-by: Andrea Stacchiotti <andreastacchiotti@gmail.com>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
Hi Andrea,

Andrea Stacchiotti wrote[1]:

Thanks for reporting.  How about this patch?

Thanks, Jonathan

[1] http://bugs.debian.org/827844

-- >8 --
Subject: doc: git-htmldocs.googlecode.com is no more

 Documentation/git.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Jonathan Nieder <jrnieder@gmail.com> writes:

http://thread.gmane.org/gmane.comp.version-control.git/296483/focus=296575

Peff suggested to use the github pages that are connected to the "git" org, and helped its initial set-up. When I update the prebuilt docs, in addition to the listed locations, I also push to the gh-pages branch of https://github.com/git/htmldocs repository and the result appears in https://git.github.io/htmldocs/git.html

Even though we do have index.html -> git.html, gh-pages does not seem to let you follow it, so you need to start from git.html, and I suspect that it is why the below says "I wasn't able to find it" for (5).

So perhaps list both? I do not know how beefy repo.or.cz is, or how well connected it is to the rest of the world, but if I have to pick only one, I'd feel safer if we didn't have to exploit the "blob_plain/:" backdoor.

Thanks.

http://git-htmldocs.googlecode.com/git/git.html says

 There was no service found for the uri requested.

Link to the rendered documentation on Jekyll instead.

Reported-by: Andrea Stacchiotti <andreastacchiotti@gmail.com>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
Junio C Hamano wrote:

Yup, that explains it.

There's only one option that uses https, so let's just use that one.

Thanks for the pointers.

Jonathan

 Documentation/git.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

On Wed, Jun 22, 2016 at 10:00:56AM -0700, Junio C Hamano wrote:

Yeah, I looked into this a little back then, and I think it is simply that the Pages builder does not handle symlinks at all. You could push out index.html as a true copy rather than a symlink, but I think just pointing to "git.html" as the entry page of the site is reasonable, too (we could even make index.html a true overview page later if we want).

Beefiness aside, the GitHub version will be served out of a CDN, which means it should perform way better for the user, as it will often get served from a geographically local cache.

-Peff

Jonathan Nieder <jrnieder@gmail.com> wrote:

Just wondering, who updates https://kernel.org/pub/software/scm/git/docs/ and why hasn't it been updated in a while? (currently it says Last updated 2015-06-06 at the bottom)

I normally link people there since I would rather not advertise for a commercial service.

On Wed, Jun 22, 2016 at 12:00 PM, Eric Wong <e@80x24.org> wrote:

Nobody. It is too cumbersome to use their upload tool to update many files (it is geared towards updating a handful of tarballs at a time).

Junio C Hamano <gitster@pobox.com> wrote:

Alright, I've setup https://git-htmldocs.bogomips.org/ for my own usage, at least. It should check for updates twice an hour(*), and plain HTTP is also available in case Let's Encrypt goes away.

Can't hurt to have more mirrors: ----------------------8<--------------------- #!/bin/sh set -e DST=/path/to/server-docroot/git-htmldocs # my mirror of git://git.kernel.org/pub/scm/git/git-htmldocs.git: GIT_DIR=/path/to/mirrors/git-htmldocs.git export GIT_DIR

# rsync from a temporary dir for atomicity so nobody fetches # a partially written file tmp="$(mktemp -t -d htmldocs.XXXXXXX)" git archive --format=tar HEAD | tar x -C "$tmp" chmod 755 "$tmp" rsync -a "$tmp/" "$DST/" rm -rf "$tmp"

# for servers which support pre-gzipped files (e.g. gzip_static in nginx)
find "$DST" -type f -name '*.html' -o -name '*.txt' | while read file
do
	gz="$file.gz"
	if ! test -e "$gz" || test "$gz" -ot "$file"
	then
		gztmp="$gz.$$.tmp"
		gzip -9 <"$file" >"$gztmp"
		touch -r "$file" "$gztmp"
		mv "$gztmp" "$gz"
	fi
done
---
(*) On a side note, It would be nice to something like IMAP IDLE
    for real-time updates of mirrors.

Junio C Hamano <gitster@pobox.com> writes:

Then, I guess it would make sense to remove it to avoid pointing users to outdated docs?

Matthieu Moy <Matthieu.Moy@grenoble-inp.fr> writes:

I'll see what I can do at k.org these days.

Don't hold your breath, don't stay tuned, but don't be surprised if you see a positive change in the future ;-)

Thanks.

Matthieu Moy <Matthieu.Moy@grenoble-inp.fr> writes:

Actually, it turns out that k.org folks have an auto-builder that updates the documentation set for each release. It hasn't been run since v2.5 days, though, until very recently.

I was told that the above URL currently should be showing v2.9.0 docs.

The rule for https://kernel.org/pub/software/scm/git/docs/ currently is that it shows documentation set for a released, but this is likely to change in the future (s/a released/the latest release/ at the minimum, with some definition of "the latest").

Also https://kernel.org/pub/software/scm/git/docs/v2.4.0/git.html would give you the documentation set for that version.