bug#22543: 404 in Manualpage

bug#22543: 404 in Manualpage

[Nils Gillmann]

The manual page
https://www.gnu.org/software/guix/manual/html_node/Requirements.html#Requirements

contains a link to

https://www.gnu.org/software/guix/manual/gnutls-guile/Guile-Preparations.html#Guile-Preparations

which give a 404. I am not familiar with what's supposed to be there, a
quick search for "gnutls-guile/Guile-Preparations.html" in duckduckgo gives me
http://www.gnutls.org/manual/gnutls-guile/Guile-Preparations.html as one
of 2 results.

Should I fix the link to this one and send in a patch?

Thanks,
-- 
ng/ni*
vcard: http://krosos.sdf.org

bug#22543: 404 in Manualpage

[Leo Famulari]

On Wed, Feb 03, 2016 at 02:41:04PM +0100, Nils Gillmann wrote:
> The manual page
> https://www.gnu.org/software/guix/manual/html_node/Requirements.html#Requirements
> 
> contains a link to
> 
> https://www.gnu.org/software/guix/manual/gnutls-guile/Guile-Preparations.html#Guile-Preparations
> 
> which give a 404. I am not familiar with what's supposed to be there, a
> quick search for "gnutls-guile/Guile-Preparations.html" in duckduckgo gives me
> http://www.gnutls.org/manual/gnutls-guile/Guile-Preparations.html as one
> of 2 results.
> 
> Should I fix the link to this one and send in a patch?

Yes, please!

bug#22543: 404 in Manualpage

[Alex Kost]

Nils Gillmann (2016-02-03 16:41 +0300) wrote:

> The manual page
> https://www.gnu.org/software/guix/manual/html_node/Requirements.html#Requirements
>
> contains a link to
>
> https://www.gnu.org/software/guix/manual/gnutls-guile/Guile-Preparations.html#Guile-Preparations
>
> which give a 404. I am not familiar with what's supposed to be there, a
> quick search for "gnutls-guile/Guile-Preparations.html" in duckduckgo gives me
> http://www.gnutls.org/manual/gnutls-guile/Guile-Preparations.html as one
> of 2 results.
>
> Should I fix the link to this one and send in a patch?

I don't think you can send a patch for this.  According to
<https://www.gnu.org/software/guix/manual/>:

  (This page generated by the gendocs.sh¹ script.)

This "gendocs.sh" uses "texi2html" to convert our texinfo documentation
(see "doc/guix.texi" in the guix git repo) to the html page.  In
"guix.texi" the link you are talking about is a usual link to the
"gnutls-guile" manual.  I didn't look at "texi2html" but I believe by
default it just assumes that all the manuals are placed at
"www.gnu.org/software/<package>/manual/", so for "external" manuals the
generated links are false.  For example, there are also wrong links to
Geiser and Magit-Popup manuals.

So I think it's a general thing for all generated manuals that are
placed on "gnu.org".

¹ http://git.savannah.gnu.org/cgit/gnulib.git/plain/build-aux/gendocs.sh

-- 
Alex

bug#22543: 404 in Manualpage

[Nils Gillmann]

Leo Famulari <leo@famulari.name> writes:

> On Wed, Feb 03, 2016 at 02:41:04PM +0100, Nils Gillmann wrote:
>> The manual page
>> https://www.gnu.org/software/guix/manual/html_node/Requirements.html#Requirements
>> 
>> contains a link to
>> 
>> https://www.gnu.org/software/guix/manual/gnutls-guile/Guile-Preparations.html#Guile-Preparations
>> 
>> which give a 404. I am not familiar with what's supposed to be there, a
>> quick search for "gnutls-guile/Guile-Preparations.html" in duckduckgo gives me
>> http://www.gnutls.org/manual/gnutls-guile/Guile-Preparations.html as one
>> of 2 results.
>> 
>> Should I fix the link to this one and send in a patch?
>
> Yes, please!

So you think I should (and can?) fix it, while alex replies:

>> I don't think you can send a patch for this.  According to
>> <https://www.gnu.org/software/guix/manual/>:
>>
>>  (This page generated by the gendocs.sh¹ script.)

>> This "gendocs.sh" uses "texi2html" to convert our texinfo documentation
>> (see "doc/guix.texi" in the guix git repo) to the html page.  In
>> "guix.texi" the link you are talking about is a usual link to the
>> "gnutls-guile" manual.  I didn't look at "texi2html" but I believe by
>> default it just assumes that all the manuals are placed at
>> "www.gnu.org/software/<package>/manual/", so for "external" manuals the
>> generated links are false.  For example, there are also wrong links to
>> Geiser and Magit-Popup manuals.
>>
>> So I think it's a general thing for all generated manuals that are
>> placed on "gnu.org".
>>
>> ¹ http://git.savannah.gnu.org/cgit/gnulib.git/plain/build-aux/gendocs.sh
>>
>> -- 
>> Alex

Okay, so I guess it's related to #22651 and it#s not fixable the
way I want to (edit the source), or at least what I would want to
do is not optimal and it should be fixed in some other way.

Didn't look into it yet, but should we follow #22651 for the 404s?
-- 
ng

bug#22543: 404 in Manualpage

[Alex Kost]

Nils Gillmann (2016-02-16 12:56 +0300) wrote:

>>> I don't think you can send a patch for this.  According to
>>> <https://www.gnu.org/software/guix/manual/>:
>>>
>>>  (This page generated by the gendocs.sh¹ script.)
>
>>> This "gendocs.sh" uses "texi2html" to convert our texinfo documentation
>>> (see "doc/guix.texi" in the guix git repo) to the html page.  In
>>> "guix.texi" the link you are talking about is a usual link to the
>>> "gnutls-guile" manual.  I didn't look at "texi2html" but I believe by
>>> default it just assumes that all the manuals are placed at
>>> "www.gnu.org/software/<package>/manual/", so for "external" manuals the
>>> generated links are false.  For example, there are also wrong links to
>>> Geiser and Magit-Popup manuals.
>>>
>>> So I think it's a general thing for all generated manuals that are
>>> placed on "gnu.org".
>>>
>>> ¹ http://git.savannah.gnu.org/cgit/gnulib.git/plain/build-aux/gendocs.sh
>
> Okay, so I guess it's related to #22651 and it#s not fixable the
> way I want to (edit the source), or at least what I would want to
> do is not optimal and it should be fixed in some other way.
>
> Didn't look into it yet, but should we follow #22651 for the 404s?

As I see it, these issues about online manual are totally unrelated to
Guix itself.  If there is something to do about it, it should be done in
some other place (where .texi files are converted into html pages for
gnu.org).

-- 
Alex

bug#22543: 404 in Manualpage

[Ludovic Courtès]

The broken links stem from missing/incomplete cross-reference info for
‘makeinfo’ in the ‘htmlxref.cnf’ config file (info "(texinfo) HTML Xref
Configuration").

Commit 49e0ca9 adds this file to the repo, taken from Texinfo 6.1 and
modified to fix some of the links (like GnuTLS) and include others
(Shepherd, Guile-Avahi, etc.)

When we update the manual for the next release, everything will be
alright hopefully.  In the meantime, it’s easier to leave things as is,
and hopefully not too much of an issue.

Thanks,
Ludo’.

bug#22543: 404 in Manualpage

[Alex Kost]

Ludovic Courtès (2016-02-22 00:30 +0300) wrote:

> The broken links stem from missing/incomplete cross-reference info for
> ‘makeinfo’ in the ‘htmlxref.cnf’ config file (info "(texinfo) HTML Xref
> Configuration").
>
> Commit 49e0ca9 adds this file to the repo, taken from Texinfo 6.1 and
> modified to fix some of the links (like GnuTLS) and include others
> (Shepherd, Guile-Avahi, etc.)
>
> When we update the manual for the next release, everything will be
> alright hopefully.  In the meantime, it’s easier to leave things as is,
> and hopefully not too much of an issue.

Wow, great!  I didn't think this could be fixed on the Guix side.

-- 
Alex