* [PATCH] doc: git-htmldocs.googlecode.com is no more
[not found] <146652690896.29270.13813898006180324611.reportbug@duelitri>
@ 2016-06-22 2:41 ` Jonathan Nieder
2016-06-22 17:00 ` Junio C Hamano
2016-06-22 19:00 ` Eric Wong
0 siblings, 2 replies; 10+ messages in thread
From: Jonathan Nieder @ 2016-06-22 2:41 UTC (permalink / raw)
To: Andrea Stacchiotti; +Cc: git, Junio C Hamano
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]:
> In the git manual (`man git`), the documentation link:
> > 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]
--
^ permalink raw reply related [flat|nested] 10+ messages in thread
* Re: [PATCH] doc: git-htmldocs.googlecode.com is no more
2016-06-22 2:41 ` [PATCH] doc: git-htmldocs.googlecode.com is no more Jonathan Nieder
@ 2016-06-22 17:00 ` Junio C Hamano
2016-06-22 17:38 ` [PATCH v2] " Jonathan Nieder
2016-06-22 20:06 ` [PATCH] " Jeff King
2016-06-22 19:00 ` Eric Wong
1 sibling, 2 replies; 10+ messages in thread
From: Junio C Hamano @ 2016-06-22 17:00 UTC (permalink / raw)
To: Jonathan Nieder; +Cc: Andrea Stacchiotti, git
Jonathan Nieder <jrnieder@gmail.com> 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.
> 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]:
>
>> In the git manual (`man git`), the documentation link:
>> > 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]
^ permalink raw reply [flat|nested] 10+ messages in thread
* [PATCH v2] doc: git-htmldocs.googlecode.com is no more
2016-06-22 17:00 ` Junio C Hamano
@ 2016-06-22 17:38 ` Jonathan Nieder
2016-06-22 20:06 ` [PATCH] " Jeff King
1 sibling, 0 replies; 10+ messages in thread
From: Jonathan Nieder @ 2016-06-22 17:38 UTC (permalink / raw)
To: Junio C Hamano; +Cc: Andrea Stacchiotti, git
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:
> 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]
--
^ permalink raw reply related [flat|nested] 10+ messages in thread
* Re: [PATCH] doc: git-htmldocs.googlecode.com is no more
2016-06-22 2:41 ` [PATCH] doc: git-htmldocs.googlecode.com is no more Jonathan Nieder
2016-06-22 17:00 ` Junio C Hamano
@ 2016-06-22 19:00 ` Eric Wong
2016-06-22 19:02 ` Junio C Hamano
1 sibling, 1 reply; 10+ messages in thread
From: Eric Wong @ 2016-06-22 19:00 UTC (permalink / raw)
To: Jonathan Nieder, Junio C Hamano; +Cc: Andrea Stacchiotti, git
Jonathan Nieder <jrnieder@gmail.com> wrote:
> 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
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.
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH] doc: git-htmldocs.googlecode.com is no more
2016-06-22 19:00 ` Eric Wong
@ 2016-06-22 19:02 ` Junio C Hamano
2016-06-22 21:48 ` Eric Wong
2016-06-23 7:04 ` Matthieu Moy
0 siblings, 2 replies; 10+ messages in thread
From: Junio C Hamano @ 2016-06-22 19:02 UTC (permalink / raw)
To: Eric Wong; +Cc: Jonathan Nieder, Andrea Stacchiotti, Git Mailing List
On Wed, Jun 22, 2016 at 12:00 PM, Eric Wong <e@80x24.org> 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)
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).
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH] doc: git-htmldocs.googlecode.com is no more
2016-06-22 17:00 ` Junio C Hamano
2016-06-22 17:38 ` [PATCH v2] " Jonathan Nieder
@ 2016-06-22 20:06 ` Jeff King
1 sibling, 0 replies; 10+ messages in thread
From: Jeff King @ 2016-06-22 20:06 UTC (permalink / raw)
To: Junio C Hamano; +Cc: Jonathan Nieder, Andrea Stacchiotti, git
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
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH] doc: git-htmldocs.googlecode.com is no more
2016-06-22 19:02 ` Junio C Hamano
@ 2016-06-22 21:48 ` Eric Wong
2016-06-23 7:04 ` Matthieu Moy
1 sibling, 0 replies; 10+ messages in thread
From: Eric Wong @ 2016-06-22 21:48 UTC (permalink / raw)
To: Junio C Hamano; +Cc: Jonathan Nieder, Andrea Stacchiotti, Git Mailing List
Junio C Hamano <gitster@pobox.com> wrote:
> On Wed, Jun 22, 2016 at 12:00 PM, Eric Wong <e@80x24.org> 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)
>
> 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).
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.
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH] doc: git-htmldocs.googlecode.com is no more
2016-06-22 19:02 ` Junio C Hamano
2016-06-22 21:48 ` Eric Wong
@ 2016-06-23 7:04 ` Matthieu Moy
2016-06-24 19:48 ` Junio C Hamano
2016-06-28 18:03 ` Junio C Hamano
1 sibling, 2 replies; 10+ messages in thread
From: Matthieu Moy @ 2016-06-23 7:04 UTC (permalink / raw)
To: Junio C Hamano
Cc: Eric Wong, Jonathan Nieder, Andrea Stacchiotti, Git Mailing List
Junio C Hamano <gitster@pobox.com> writes:
> On Wed, Jun 22, 2016 at 12:00 PM, Eric Wong <e@80x24.org> 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)
>
> 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).
Then, I guess it would make sense to remove it to avoid pointing users
to outdated docs?
--
Matthieu Moy
http://www-verimag.imag.fr/~moy/
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH] doc: git-htmldocs.googlecode.com is no more
2016-06-23 7:04 ` Matthieu Moy
@ 2016-06-24 19:48 ` Junio C Hamano
2016-06-28 18:03 ` Junio C Hamano
1 sibling, 0 replies; 10+ messages in thread
From: Junio C Hamano @ 2016-06-24 19:48 UTC (permalink / raw)
To: Matthieu Moy
Cc: Eric Wong, Jonathan Nieder, Andrea Stacchiotti, Git Mailing List
Matthieu Moy <Matthieu.Moy@grenoble-inp.fr> writes:
> Junio C Hamano <gitster@pobox.com> writes:
>
>> On Wed, Jun 22, 2016 at 12:00 PM, Eric Wong <e@80x24.org> 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)
>>
>> 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).
>
> Then, I guess it would make sense to remove it to avoid pointing users
> to outdated docs?
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.
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH] doc: git-htmldocs.googlecode.com is no more
2016-06-23 7:04 ` Matthieu Moy
2016-06-24 19:48 ` Junio C Hamano
@ 2016-06-28 18:03 ` Junio C Hamano
1 sibling, 0 replies; 10+ messages in thread
From: Junio C Hamano @ 2016-06-28 18:03 UTC (permalink / raw)
To: Matthieu Moy
Cc: Eric Wong, Jonathan Nieder, Andrea Stacchiotti, Git Mailing List
Matthieu Moy <Matthieu.Moy@grenoble-inp.fr> writes:
> Junio C Hamano <gitster@pobox.com> writes:
>
>> On Wed, Jun 22, 2016 at 12:00 PM, Eric Wong <e@80x24.org> 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)
>>
>> 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).
>
> Then, I guess it would make sense to remove it to avoid pointing users
> to outdated docs?
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.
^ permalink raw reply [flat|nested] 10+ messages in thread
end of thread, other threads:[~2016-06-28 18:03 UTC | newest]
Thread overview: 10+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
[not found] <146652690896.29270.13813898006180324611.reportbug@duelitri>
2016-06-22 2:41 ` [PATCH] doc: git-htmldocs.googlecode.com is no more Jonathan Nieder
2016-06-22 17:00 ` Junio C Hamano
2016-06-22 17:38 ` [PATCH v2] " Jonathan Nieder
2016-06-22 20:06 ` [PATCH] " Jeff King
2016-06-22 19:00 ` Eric Wong
2016-06-22 19:02 ` Junio C Hamano
2016-06-22 21:48 ` Eric Wong
2016-06-23 7:04 ` Matthieu Moy
2016-06-24 19:48 ` Junio C Hamano
2016-06-28 18:03 ` Junio C Hamano
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.