Re: [PATCH] doc: git-htmldocs.googlecode.com is no more

3 messages, 3 authors, 2016-06-22 · open the first message on its own page

Re: [PATCH] doc: git-htmldocs.googlecode.com is no more

From: Junio C Hamano <hidden>
Date: 2016-06-22 17:01:05

Jonathan Nieder [off-list ref] writes:
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.
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.
quoted hunk
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 <redacted>
Signed-off-by: Jonathan Nieder <redacted>
---
Hi Andrea,

Andrea Stacchiotti wrote[1]:
quoted
In the git manual (`man git`), the documentation link:
quoted
http://git-htmldocs.googlecode.com/git/git.html
is broken.
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(-)
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 5490d3c..de923db 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -31,8 +31,8 @@ page to learn what commands Git offers.  You can learn more about
 individual Git commands with "git help command".  linkgit:gitcli[7]
 manual page gives you an overview of the command-line command syntax.
 
-Formatted and hyperlinked version of the latest Git documentation
-can be viewed at `http://git-htmldocs.googlecode.com/git/git.html`.
+A formatted and hyperlinked copy of the latest Git documentation
+can be viewed at `http://repo.or.cz/git-htmldocs.git/blob_plain/:/git.html`.
 
 ifdef::stalenotes[]
 [NOTE]

[PATCH v2] doc: git-htmldocs.googlecode.com is no more

From: Jonathan Nieder <hidden>
Date: 2016-06-22 17:38:33

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 <redacted>
Signed-off-by: Jonathan Nieder <redacted>
---
Junio C Hamano wrote:
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).
Yup, that explains it.
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.
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(-)
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 5490d3c..0fb14f1 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -31,8 +31,8 @@ page to learn what commands Git offers.  You can learn more about
 individual Git commands with "git help command".  linkgit:gitcli[7]
 manual page gives you an overview of the command-line command syntax.
 
-Formatted and hyperlinked version of the latest Git documentation
-can be viewed at `http://git-htmldocs.googlecode.com/git/git.html`.
+A formatted and hyperlinked copy of the latest Git documentation
+can be viewed at `https://git.github.io/htmldocs/git.html`.
 
 ifdef::stalenotes[]
 [NOTE]
-- 

Re: [PATCH] doc: git-htmldocs.googlecode.com is no more

From: Jeff King <hidden>
Date: 2016-06-22 20:06:13

On Wed, Jun 22, 2016 at 10:00:56AM -0700, Junio C Hamano wrote:
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).
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).
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.
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
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help