Re: Makeinfo generates wrong link

Re: Makeinfo generates wrong link

[Gavin Smith]

On Sun, Oct 02, 2022 at 09:06:06PM -0400, Richard Stallman wrote:
> generates the following output:
> 
>     <li> Some macros are predefined on each kind of machine
>     (see <a href="https://gcc.gnu.org/onlinedocs/gcc/System_002dspecific-Predefined-Macros.html#System_002dspecific-Predefined-Macros">System-specific Predefined Macros</a> in <cite>Using the GNU Compiler
>     Collection</cite>).  This allows you to provide code specially tuned for a
>     particular machine.
> 
> but that link is broken.  The OP suggests this link
> 
> https://gcc.gnu.org/onlinedocs/gcc-4.8.5/cpp/System-specific-Predefined-Macros.html
> 
> may be correct.
> 
> Where do those directory names come from?  Is there a table in makeinfo
> that needs to be updated?


It comes from the htmlxref.cnf file.  (It may be installed under
/usr/share/texinfo/.) The link produced above matches the
current entry for the "gcc" manual in that file.

Changing that file would change the link, e.g.

--- a/util/htmlxref.cnf
+++ b/util/htmlxref.cnf
@@ -340,7 +340,7 @@ gcal                mono    ${GS}/gcal/manual/gcal.html
 gcal           node    ${GS}/gcal/manual/html_node/
 
 GCC = https://gcc.gnu.org/onlinedocs
-gcc            node    ${GCC}/gcc/
+gcc            node    ${GCC}/gcc-4.8.5/
  cpp           node    ${GCC}/cpp/
  gfortran      node    ${GCC}/gfortran/
  gnat_rm       node    ${GCC}/gnat_rm/


However, it's wrong to make it link to a specific version.

The gcc developers need to provide a stable, version-independent link
for the manual.  This link would have worked in the past, but I don't
know how recently it broke.

I'm attempting to CC the gcc mailing list stated on their documentation page
to see if anyone there can give any information.

Re: Makeinfo generates wrong link

[Jonathan Wakely]

On Mon, 3 Oct 2022 at 07:01, Gavin Smith via Gcc <gcc@gcc.gnu.org> wrote:
>
> On Sun, Oct 02, 2022 at 09:06:06PM -0400, Richard Stallman wrote:
> > generates the following output:
> >
> >     <li> Some macros are predefined on each kind of machine
> >     (see <a href="https://gcc.gnu.org/onlinedocs/gcc/System_002dspecific-Predefined-Macros.html#System_002dspecific-Predefined-Macros">System-specific Predefined Macros</a> in <cite>Using the GNU Compiler
> >     Collection</cite>).  This allows you to provide code specially tuned for a
> >     particular machine.
> >
> > but that link is broken.  The OP suggests this link
> >
> > https://gcc.gnu.org/onlinedocs/gcc-4.8.5/cpp/System-specific-Predefined-Macros.html
> >
> > may be correct.
> >
> > Where do those directory names come from?  Is there a table in makeinfo
> > that needs to be updated?
>
>
> It comes from the htmlxref.cnf file.  (It may be installed under
> /usr/share/texinfo/.) The link produced above matches the
> current entry for the "gcc" manual in that file.
>
> Changing that file would change the link, e.g.
>
> --- a/util/htmlxref.cnf
> +++ b/util/htmlxref.cnf
> @@ -340,7 +340,7 @@ gcal                mono    ${GS}/gcal/manual/gcal.html
>  gcal           node    ${GS}/gcal/manual/html_node/
>
>  GCC = https://gcc.gnu.org/onlinedocs
> -gcc            node    ${GCC}/gcc/
> +gcc            node    ${GCC}/gcc-4.8.5/
>   cpp           node    ${GCC}/cpp/
>   gfortran      node    ${GCC}/gfortran/
>   gnat_rm       node    ${GCC}/gnat_rm/
>
>
> However, it's wrong to make it link to a specific version.
>
> The gcc developers need to provide a stable, version-independent link
> for the manual.  This link would have worked in the past, but I don't
> know how recently it broke.

The URL https://gcc.gnu.org/onlinedocs/cpp/System-specific-Predefined-Macros.html
has been stable for many years.


>
> I'm attempting to CC the gcc mailing list stated on their documentation page
> to see if anyone there can give any information.

Re: Makeinfo generates wrong link

[Jonathan Wakely]

[-- Attachment #1: Type: text/plain, Size: 2891 bytes --]

On Mon, 3 Oct 2022, 08:31 Jonathan Wakely, <jwakely.gcc@gmail.com> wrote:

> On Mon, 3 Oct 2022 at 07:01, Gavin Smith via Gcc <gcc@gcc.gnu.org> wrote:
> >
> > On Sun, Oct 02, 2022 at 09:06:06PM -0400, Richard Stallman wrote:
> > > generates the following output:
> > >
> > >     <li> Some macros are predefined on each kind of machine
> > >     (see <a href="
> https://gcc.gnu.org/onlinedocs/gcc/System_002dspecific-Predefined-Macros.html#System_002dspecific-Predefined-Macros">System-specific
> Predefined Macros</a> in <cite>Using the GNU Compiler
> > >     Collection</cite>).  This allows you to provide code specially
> tuned for a
> > >     particular machine.
> > >
> > > but that link is broken.  The OP suggests this link
> > >
> > >
> https://gcc.gnu.org/onlinedocs/gcc-4.8.5/cpp/System-specific-Predefined-Macros.html
> > >
> > > may be correct.
> > >
> > > Where do those directory names come from?  Is there a table in makeinfo
> > > that needs to be updated?
> >
> >
> > It comes from the htmlxref.cnf file.  (It may be installed under
> > /usr/share/texinfo/.) The link produced above matches the
> > current entry for the "gcc" manual in that file.
> >
> > Changing that file would change the link, e.g.
> >
> > --- a/util/htmlxref.cnf
> > +++ b/util/htmlxref.cnf
> > @@ -340,7 +340,7 @@ gcal                mono
> ${GS}/gcal/manual/gcal.html
> >  gcal           node    ${GS}/gcal/manual/html_node/
> >
> >  GCC = https://gcc.gnu.org/onlinedocs
> > -gcc            node    ${GCC}/gcc/
> > +gcc            node    ${GCC}/gcc-4.8.5/
> >   cpp           node    ${GCC}/cpp/
> >   gfortran      node    ${GCC}/gfortran/
> >   gnat_rm       node    ${GCC}/gnat_rm/
> >
> >
> > However, it's wrong to make it link to a specific version.
> >
> > The gcc developers need to provide a stable, version-independent link
> > for the manual.  This link would have worked in the past, but I don't
> > know how recently it broke.
>
> The URL
> https://gcc.gnu.org/onlinedocs/cpp/System-specific-Predefined-Macros.html
> has been stable for many years.
>

Although in general the gcc.gnu.org/onlinedocs/gcc/... and
gcc.gnu.org/onlinedocs/cpp/... pages are for the development trunk, and so
they can change e.g. when texinfo changes how it escapes non-ASCII
characters in output filenames, or when sections of the manual are renamed
or removed (which isn't common, but is possible).

If you want a stable URL, consider linking to a specific release not the
development trunk (but gcc-4.8.5 seems like a poor choice given its
antiquity). Otherwise, if you do want to link from an external site to
something in the development trunk docs, at least let the GCC project know
so that we can try to put redirects in place if/when that URL changes.




>
> >
> > I'm attempting to CC the gcc mailing list stated on their documentation
> page
> > to see if anyone there can give any information.
>

Re: Makeinfo generates wrong link

[Gavin Smith]

On Mon, Oct 03, 2022 at 08:31:06AM +0100, Jonathan Wakely wrote:
> On Mon, 3 Oct 2022 at 07:01, Gavin Smith via Gcc <gcc@gcc.gnu.org> wrote:
> >
> > On Sun, Oct 02, 2022 at 09:06:06PM -0400, Richard Stallman wrote:
> > > generates the following output:
> > >
> > >     <li> Some macros are predefined on each kind of machine
> > >     (see <a href="https://gcc.gnu.org/onlinedocs/gcc/System_002dspecific-Predefined-Macros.html#System_002dspecific-Predefined-Macros">System-specific Predefined Macros</a> in <cite>Using the GNU Compiler
> > >     Collection</cite>).  This allows you to provide code specially tuned for a
> > >     particular machine.
> > >
> > > but that link is broken.  The OP suggests this link
> > >
> > > https://gcc.gnu.org/onlinedocs/gcc-4.8.5/cpp/System-specific-Predefined-Macros.html
> > >
> > > may be correct.
> > >
> > > Where do those directory names come from?  Is there a table in makeinfo
> > > that needs to be updated?

> > The gcc developers need to provide a stable, version-independent link
> > for the manual.  This link would have worked in the past, but I don't
> > know how recently it broke.
> 
> The URL https://gcc.gnu.org/onlinedocs/cpp/System-specific-Predefined-Macros.html
> has been stable for many years.

In that case it is the input that is wrong:

    Some macros are predefined on each kind of machine
    (@pxref{System-specific Predefined Macros, System-specific Predefined
    Macros, System-specific Predefined Macros, gcc, Using the GNU Compiler
    Collection}).  This allows you to provide code specially tuned for a
    particular machine.

It should be

    Some macros are predefined on each kind of machine
    (@pxref{System specific Predefined Macros, System specific Predefined
    Macros, System-specific Predefined Macros, gcc, Using the GNU Compiler
    Collection}).  This allows you to provide code specially tuned for a
    particular machine.

changing the hyphen to a space in "System specific".

Re: Makeinfo generates wrong link

[Richard Stallman]

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

  >     Some macros are predefined on each kind of machine
  >     (@pxref{System specific Predefined Macros, System specific Predefined
  >     Macros, System-specific Predefined Macros, gcc, Using the GNU Compiler
  >     Collection}).  This allows you to provide code specially tuned for a
  >     particular machine.

  > changing the hyphen to a space in "System specific".

I will make that change.  Thanks.

-- 
Dr Richard Stallman (https://stallman.org)
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)

Re: Makeinfo generates wrong link

[Jacob Bachmeyer]

Gavin Smith wrote:
> On Mon, Oct 03, 2022 at 08:31:06AM +0100, Jonathan Wakely wrote:
>   
>> On Mon, 3 Oct 2022 at 07:01, Gavin Smith via Gcc <gcc@gcc.gnu.org> wrote:
>>     
>>> On Sun, Oct 02, 2022 at 09:06:06PM -0400, Richard Stallman wrote:
>>>       
>>> [...]
>>> The gcc developers need to provide a stable, version-independent link
>>> for the manual.  This link would have worked in the past, but I don't
>>> know how recently it broke.
>>>       
>> The URL https://gcc.gnu.org/onlinedocs/cpp/System-specific-Predefined-Macros.html
>> has been stable for many years.
>>     
>
> In that case it is the input that is wrong:
>
>     Some macros are predefined on each kind of machine
>     (@pxref{System-specific Predefined Macros, System-specific Predefined
>     Macros, System-specific Predefined Macros, gcc, Using the GNU Compiler
>     Collection}).  This allows you to provide code specially tuned for a
>     particular machine.
>
> It should be
>
>     Some macros are predefined on each kind of machine
>     (@pxref{System specific Predefined Macros, System specific Predefined
>     Macros, System-specific Predefined Macros, gcc, Using the GNU Compiler
>     Collection}).  This allows you to provide code specially tuned for a
>     particular machine.
>
> changing the hyphen to a space in "System specific".
>   

There is one additional error here if the above-mentioned URL is 
correct:  the reference should point to the (cpp) manual instead of the 
(gcc) manual.


-- Jacob

Re: Makeinfo generates wrong link

[Richard Stallman]

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

  > There is one additional error here if the above-mentioned URL is 
  > correct:  the reference should point to the (cpp) manual instead of the 
  > (gcc) manual.

What is the full, formal tit;e of the CPP manual?  Texinfo cross-references
need to specify that, as well as the short name for Info.

-- 
Dr Richard Stallman (https://stallman.org)
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)

Re: Makeinfo generates wrong link

[Gavin Smith]

On Tue, Oct 04, 2022 at 01:39:04PM -0400, Richard Stallman wrote:
> [[[ To any NSA and FBI agents reading my email: please consider    ]]]
> [[[ whether defending the US Constitution against all enemies,     ]]]
> [[[ foreign or domestic, requires you to follow Snowden's example. ]]]
> 
>   > There is one additional error here if the above-mentioned URL is 
>   > correct:  the reference should point to the (cpp) manual instead of the 
>   > (gcc) manual.
> 
> What is the full, formal tit;e of the CPP manual?  Texinfo cross-references
> need to specify that, as well as the short name for Info.

The PDF on their website is titled, simply, "The C Preprocessor".

https://gcc.gnu.org/onlinedocs/cpp.pdf
 

Re: Makeinfo generates wrong link

[Jonathan Wakely]

On Tue, 4 Oct 2022 at 20:41, Gavin Smith <gavinsmith0123@gmail.com> wrote:
>
> On Tue, Oct 04, 2022 at 01:39:04PM -0400, Richard Stallman wrote:
> > [[[ To any NSA and FBI agents reading my email: please consider    ]]]
> > [[[ whether defending the US Constitution against all enemies,     ]]]
> > [[[ foreign or domestic, requires you to follow Snowden's example. ]]]
> >
> >   > There is one additional error here if the above-mentioned URL is
> >   > correct:  the reference should point to the (cpp) manual instead of the
> >   > (gcc) manual.
> >
> > What is the full, formal tit;e of the CPP manual?  Texinfo cross-references
> > need to specify that, as well as the short name for Info.
>
> The PDF on their website is titled, simply, "The C Preprocessor".
>
> https://gcc.gnu.org/onlinedocs/cpp.pdf

Right:

\input texinfo
@setfilename cpp.info
@settitle The C Preprocessor

Re: Makeinfo generates wrong link

[Richard Stallman]

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

Does this replacement text give the right results?


@itemize @bullet
@item
Some macros are predefined on each kind of machine
(@pxref{System specific Predefined Macros, System specific Predefined
Macros, System-specific Predefined Macros, cpp, The C Preprocessor}).  This allows you to provide code specially tuned for a
particular machine.

-- 
Dr Richard Stallman (https://stallman.org)
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)