This is the mail archive of the gcc-patches@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH] Update --with-gnu-as doc entry


On Thu, 2003-06-19 at 01:25, Eric Botcazou wrote: 
> Sure, but then why are the many other references not wrapped up in a @uref 
> too? This is somewhat weird, because you have only one link in the HTML file.

In this particular case, we don't have a cross-reference to another
option.  What we have is a case where all of the documentation is
located someplace else.  In this case, a @uref seems clearly better than
@option, because otherwise it is hard to find the documentation you are
looking for in the html docs.

I also suspect that this is a case of incomplete conversion, where
someone (namely jsm) tried to convert @option to @uref to improve the
appearance of the documentation, but didn't catch all of the cases that
mattered.  We shouldn't be going backwards by removing improvements just
because they are incomplete.

If you want to pursue this farther, I suggest asking Joseph Myers for
his opinion, since he is the one that added the @uref.

> > It isn't the only one for an option, there is another one in the same file
> > for --with-gnu-as, though it explicitly mentions the configure.html file
> > whereas this one doesn't. 
> 
> I don't see it.

Search for --with-gnu-as.  It is 2/3 of the way into the file.

Jim



Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]