[BUG] Broken links in Git Documentation/user-manual.txt

[BUG] Broken links in Git Documentation/user-manual.txt

[Xue Fuqiao]

Hi list,

In https://git-scm.com/docs/user-manual.html , all links to the
glossary[1] are broken.

I'm aware of a recent bug report about broken links ($gmane/279048/),
but that one seems unrelated to what I'm reporting.

[1] For example: https://git-scm.com/docs/user-manual.html#def_head

Re: [BUG] Broken links in Git Documentation/user-manual.txt

[Matthieu Moy]

Xue Fuqiao <xfq.free@gmail.com> writes:

> Hi list,
>
> In https://git-scm.com/docs/user-manual.html , all links to the
> glossary[1] are broken.

Actually, the links themselves are fine, but the destimation is broken.

The doc is supposed to look like this :

  https://www.kernel.org/pub/software/scm/git/docs/user-manual.html#def_head

with the glossary at the end. On
https://git-scm.com/docs/user-manual.html, the glossary is displayed as
verbatim text.

This does not seem to be a bug in our user-manual.txt, but in the way
it's processed by git-scm.com.

I reported the issue there:

https://github.com/git/git-scm.com/issues/605

-- 
Matthieu Moy
http://www-verimag.imag.fr/~moy/

Re: [BUG] Broken links in Git Documentation/user-manual.txt

[John Keeping]

On Wed, Oct 14, 2015 at 09:37:05AM +0200, Matthieu Moy wrote:
> Xue Fuqiao <xfq.free@gmail.com> writes:
> 
> > Hi list,
> >
> > In https://git-scm.com/docs/user-manual.html , all links to the
> > glossary[1] are broken.
> 
> Actually, the links themselves are fine, but the destimation is broken.
> 
> The doc is supposed to look like this :
> 
>   https://www.kernel.org/pub/software/scm/git/docs/user-manual.html#def_head
> 
> with the glossary at the end. On
> https://git-scm.com/docs/user-manual.html, the glossary is displayed as
> verbatim text.
> 
> This does not seem to be a bug in our user-manual.txt, but in the way
> it's processed by git-scm.com.

I think it was an issue in the source, but was fixed by be510e0
(Documentation: fix section header mark-up, 2015-09-25).  I'm not sure
when/how git-scm.com rebulds its documentation, but I'm pretty sure that
fix hasn't made it into a release yet so I doubt the site has picked it
up.

> I reported the issue there:
> 
> https://github.com/git/git-scm.com/issues/605

Re: [BUG] Broken links in Git Documentation/user-manual.txt

[Matthieu Moy]

John Keeping <john@keeping.me.uk> writes:

> On Wed, Oct 14, 2015 at 09:37:05AM +0200, Matthieu Moy wrote:
>> Xue Fuqiao <xfq.free@gmail.com> writes:
>> 
>> > Hi list,
>> >
>> > In https://git-scm.com/docs/user-manual.html , all links to the
>> > glossary[1] are broken.
>> 
>> Actually, the links themselves are fine, but the destimation is broken.
>> 
>> The doc is supposed to look like this :
>> 
>>   https://www.kernel.org/pub/software/scm/git/docs/user-manual.html#def_head
>> 
>> with the glossary at the end. On
>> https://git-scm.com/docs/user-manual.html, the glossary is displayed as
>> verbatim text.
>> 
>> This does not seem to be a bug in our user-manual.txt, but in the way
>> it's processed by git-scm.com.
>
> I think it was an issue in the source, but was fixed by be510e0
> (Documentation: fix section header mark-up, 2015-09-25).  I'm not sure
> when/how git-scm.com rebulds its documentation, but I'm pretty sure that
> fix hasn't made it into a release yet so I doubt the site has picked it
> up.

Ah, OK. I can't reproduce the issue even with versions earlier than
be510e0, but this is because my local build uses asciidoc, and the
commit message says "Asciidoctor is stricter than AsciiDoc", and
git-scm.com seems to use asciidoctor.

The fix isn't in any release (not even in master), so it can't be in
git-scm.com.

Thanks for the pointer, I'll update the GitHub bug.

-- 
Matthieu Moy
http://www-verimag.imag.fr/~moy/