[committed] ada: Avoid invalid "up" link in manual

[committed] ada: Avoid invalid "up" link in manual

[Gerald Pfeifer]

This is something I have been noticing for a while, and a hint by 
Sandra in a somewhat similar context taught me how to avoid it.

With this patch the bottom navigation of the page at
  https://gcc.gnu.org/onlinedocs/gnat_ugn/index.html
changes from
  Next: About This Guide, Up: (dir)   [Contents][Index]
to 
  Next: About This Guide   [Contents][Index]
and the invalid "(dir)" link that pointed to
  http://gcc.gnu.org/onlinedocs/dir/index.html
which does not exist is gone.

Pushed.


Gerald (who too late realized that in the Git world he should 
       have added this explanation to the actual commit message)


commit c660464a9ef07726a5d5217b4b39def189ec21e6
Author: Gerald Pfeifer <gerald@pfeifer.com>
Date:   Sun Apr 11 11:23:41 2021 +0200

    ada: Avoid invalid "up" link in manual
    
    gcc/ada/
            * gnat_ugn.texi (Top): Avoid invalid "up" link.

diff --git a/gcc/ada/gnat_ugn.texi b/gcc/ada/gnat_ugn.texi
index 360177b042b..ae8f7580355 100644
--- a/gcc/ada/gnat_ugn.texi
+++ b/gcc/ada/gnat_ugn.texi
@@ -41,7 +41,7 @@ Copyright @copyright{} 2008-2021, Free Software Foundation
 @c %** end of user preamble
 
 @ifnottex
-@node Top
+@node Top, About This Guide
 @top GNAT User's Guide for Native Platforms
 @insertcopying
 @end ifnottex

Re: [committed] ada: Avoid invalid "up" link in manual

[Arnaud Charlet]

> This is something I have been noticing for a while, and a hint by 
> Sandra in a somewhat similar context taught me how to avoid it.
> 
> With this patch the bottom navigation of the page at
>  https://gcc.gnu.org/onlinedocs/gnat_ugn/index.html
> changes from
>  Next: About This Guide, Up: (dir)   [Contents][Index]
> to 
>  Next: About This Guide   [Contents][Index]
> and the invalid "(dir)" link that pointed to
>  http://gcc.gnu.org/onlinedocs/dir/index.html
> which does not exist is gone.
> 
> Pushed.

Well the master is the rest/sphinx files in doc, the texi file is auto generated, so your change will dispapear at the next generation.

Arno

Re: [committed] ada: Avoid invalid "up" link in manual

[Gerald Pfeifer]

On Sun, 11 Apr 2021, Arnaud Charlet wrote:
>> With this patch the bottom navigation of the page at
>>  https://gcc.gnu.org/onlinedocs/gnat_ugn/index.html
>> changes from
>>   Next: About This Guide, Up: (dir)   [Contents][Index]
>> to 
>>  Next: About This Guide   [Contents][Index]
>> and the invalid "(dir)" link that pointed to
>>  http://gcc.gnu.org/onlinedocs/dir/index.html
>> which does not exist is gone.
> Well the master is the rest/sphinx files in doc, the texi file is auto 
> generated, so your change will dispapear at the next generation.

You're right, good catch, Arnaud!

How can we fix this at the root, then? I'm not sufficiently familiar
with Sphinx and did not find where we might change that.

Is there a newer version of Sphinx available to avoid this?

Gerald

Re: [committed] ada: Avoid invalid "up" link in manual

[Arnaud Charlet]

> >> With this patch the bottom navigation of the page at
> >>  https://gcc.gnu.org/onlinedocs/gnat_ugn/index.html
> >> changes from
> >>   Next: About This Guide, Up: (dir)   [Contents][Index]
> >> to 
> >>  Next: About This Guide   [Contents][Index]
> >> and the invalid "(dir)" link that pointed to
> >>  http://gcc.gnu.org/onlinedocs/dir/index.html
> >> which does not exist is gone.
> > Well the master is the rest/sphinx files in doc, the texi file is auto 
> > generated, so your change will dispapear at the next generation.
> 
> You're right, good catch, Arnaud!
> 
> How can we fix this at the root, then? I'm not sufficiently familiar
> with Sphinx and did not find where we might change that.

You can always do some postprocessing, see gcc/ada/doc/Makefile line 66 for
an existing kludge^Wpostprocessing.

Arno