This is the mail archive of the
gcc-patches@gcc.gnu.org
mailing list for the GCC project.
Documentation patch: formatting of URLs in Texinfo manual
- To: gcc-patches at gcc dot gnu dot org
- Subject: Documentation patch: formatting of URLs in Texinfo manual
- From: "Joseph S. Myers" <jsm28 at cam dot ac dot uk>
- Date: Wed, 27 Sep 2000 16:23:44 +0100 (BST)
There is some inconsistency in the manual in how URLs are marked up.
The presently best Texinfo form seems to be @uref; this patch causes
it to be used consistently. (The G77 manual already does use it
consistently.)
@uref has forms allowing a link text to be provided as well as the
URL, but I haven't used them. Some URLs may be out of date. I think
all the URL references are best as links rather than as plain
references as would be given by @url according to current Texinfo.
This patch passes "make info". OK to commit?
2000-09-27 Joseph S. Myers <jsm28@cam.ac.uk>
* extend.texi, invoke.texi, gcc.texi, install.texi: Consistently
use @uref for formatting URLs.
--- extend.texi.orig Wed Sep 6 23:11:23 2000
+++ extend.texi Wed Sep 27 15:03:26 2000
@@ -420,7 +420,7 @@
GNU CC implements taking the address of a nested function using a
technique called @dfn{trampolines}. A paper describing them is
-available as @samp{http://master.debian.org/~karlheg/Usenix88-lexic.pdf}.
+available as @uref{http://master.debian.org/~karlheg/Usenix88-lexic.pdf}.
A nested function can jump to a label inherited from a containing
function, provided the label was explicitly declared in the containing
--- invoke.texi.orig Tue Sep 26 08:12:15 2000
+++ invoke.texi Wed Sep 27 15:03:34 2000
@@ -740,7 +740,7 @@
@item iso9899:1999
ISO C99. Note that this standard is not yet fully supported; see
-@url{http://gcc.gnu.org/c99status.html} for more information.
+@uref{http://gcc.gnu.org/c99status.html} for more information.
@item c89
same as -std=iso9899:1990
--- gcc.texi.orig Mon Aug 21 18:34:34 2000
+++ gcc.texi Wed Sep 27 15:05:40 2000
@@ -652,11 +652,10 @@
./xgcc: Internal compiler error: program as got fatal signal 11
@end smallexample
-A patched version of the assembler is available by anonymous ftp from
-@code{altdorf.ai.mit.edu} as the file
-@file{archive/cph/hpux-8.0-assembler}. If you have HP software support,
-the patch can also be obtained directly from HP, as described in the
-following note:
+A patched version of the assembler is available as the file
+@uref{ftp://altdorf.ai.mit.edu/archive/cph/hpux-8.0-assembler}. If you
+have HP software support, the patch can also be obtained directly from
+HP, as described in the following note:
@quotation
This is the patched assembler, to patch SR#1653-010439, where the
@@ -2236,7 +2235,7 @@
to @samp{bug-foo@@gnu.org}, the address @samp{bug-gcc@@gnu.org}
may also be used; it will forward to the address given above.
-Please read @samp{<URL:http://www.gnu.org/software/gcc/bugs.html>} for
+Please read @uref{http://www.gnu.org/software/gcc/bugs.html} for
bug reporting instructions before you post a bug report.
Often people think of posting bug reports to the newsgroup instead of
@@ -2260,7 +2259,7 @@
@cindex compiler bugs, reporting
You may find additional and/or more up-to-date instructions at
-@samp{<URL:http://www.gnu.org/software/gcc/bugs.html>}.
+@uref{http://www.gnu.org/software/gcc/bugs.html}.
The fundamental principle of reporting bugs usefully is this:
@strong{report all the facts}. If you are not sure whether to state a
--- install.texi.orig Thu Sep 14 07:49:35 2000
+++ install.texi Wed Sep 27 15:08:25 2000
@@ -852,7 +852,7 @@
The MIL-STD-1750A cross configuration produces output for
@code{as1750}, an assembler/linker available under the GNU Public
License for the 1750A. @code{as1750} can be obtained at
-@emph{ftp://ftp.fta-berlin.de/pub/crossgcc/1750gals/}.
+@uref{ftp://ftp.fta-berlin.de/pub/crossgcc/1750gals/}.
A similarly licensed simulator for
the 1750A is available from same address.
@@ -957,7 +957,7 @@
Any of the ARM-family processors running the Linux-based GNU system with
the @file{ELF} binary format. You must use version 2.9.1.0.22 or later
of the GNU/Linux binutils, which you can download from
-@file{ftp.varesearch.com:/pub/support/hjl/binutils}.
+@uref{ftp://ftp.varesearch.com/pub/support/hjl/binutils/}.
These two configurations differ only in the required version of GNU
binutils. For binutils 2.9.1.0.x, use @samp{arm-*-linux-gnuoldld}. For
@@ -970,7 +970,7 @@
assembler shipped with RISC iX does not support stabs debugging
information; a new version of the assembler, with stabs support
included, is now available from Acorn and via ftp
-@file{ftp.acorn.com:/pub/riscix/as+xterm.tar.Z}. To enable stabs
+@uref{ftp://ftp.acorn.com/pub/riscix/as+xterm.tar.Z}. To enable stabs
debugging, pass @samp{--with-gnu-as} to configure.
You will need to install GNU @file{sed} before you can run configure.
@@ -1179,7 +1179,7 @@
@item i[345]86-*-winnt3.5
This version requires a GAS that has not yet been released. Until it
is, you can get a prebuilt binary version via anonymous ftp from
-@file{cs.washington.edu:pub/gnat} or @file{cs.nyu.edu:pub/gnat}. You
+@uref{ftp://cs.washington.edu/pub/gnat} or @uref{ftp://cs.nyu.edu/pub/gnat}. You
must also use the Microsoft header files from the Windows NT 3.5 SDK.
Find these on the CDROM in the @file{/mstools/h} directory dated 9/4/94. You
must use a fixed version of Microsoft linker made especially for NT 3.5,
@@ -1276,7 +1276,7 @@
be compiled with the system C compiler, which is too buggy.
You will need to get a previous version of GCC and use it to
bootstrap. Binaries are available from the OSU-CIS archive, at
-@url{ftp://archive.cis.ohio-state.edu/pub/att7300/}.
+@uref{ftp://archive.cis.ohio-state.edu/pub/att7300/}.
@item m68k-bull-sysv
Bull DPX/2 series 200 and 300 with BOS-2.00.45 up to BOS-2.01. GNU CC works
--
Joseph S. Myers
jsm28@cam.ac.uk