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]

Patch to make old install manual a chapter of the new


This patch moves the old install manual from the main GCC manual to
being a chapter of the new install manual.  (The new install manual
isn't a particularly good place either, but I want to get it out of
the main manual so I can split that into user and internals manuals
before the feature freeze, then rework the structure of the internals
manual and put appropriate section headings and empty sections there
for people hopefully to fill in with more information over the next
two months, cf the suggestion at
http://gcc.gnu.org/ml/gcc-patches/2001-11/msg00637.html that having
the outline present would make people fill it in.  This logical
structure has three manuals (user, install, internals) by audience and
the old install docs certainly don't belong somewhere other than the
install manual.  Nor have volunteers dealt with merging the residual
parts of the old install manual into the new.)

It passes makeinfo, texi2dvi and install.texi2html.  OK to commit to
mainline?

2001-12-07  Joseph S. Myers  <jsm28@cam.ac.uk>

	* doc/gcc.texi: Don't include install-old.texi.  Adjust menu
	description for Trouble section.
	* doc/install-old.texi: Adjust for inclusion as chapter of new
	installation manual.
	* doc/install.texi, doc/include/fdl.texi: Adjust to include old
	installation chapter as chapter of new installation manual.

diff -ruN doc.orig/gcc.texi doc/gcc.texi
--- doc.orig/gcc.texi	Mon Nov 19 12:36:34 2001
+++ doc/gcc.texi	Fri Dec  7 11:56:37 2001
@@ -239,13 +239,12 @@
 * G++ and GCC::     You can compile C or C++ programs.
 * Standards::       Language standards supported by GCC.
 * Invoking GCC::    Command options supported by @samp{gcc}.
-* Installation::    How to configure, compile and install GCC (out of date).
 * C Implementation:: How GCC implements the ISO C specification.
 * C Extensions::    GNU extensions to the C language family.
 * C++ Extensions::  GNU extensions to the C++ language.
 * Objective-C::     GNU Objective-C runtime features.
 * Gcov::	    gcov: a GCC test coverage program.
-* Trouble::         If you have trouble installing GCC.
+* Trouble::         If you have trouble using GCC.
 * Bugs::            How, why and where to report bugs.
 * Service::         How to find suppliers of support for GCC.
 * Contributing::    How to contribute to testing and developing GCC.
@@ -286,8 +285,6 @@
 @include standards.texi
 
 @include invoke.texi
-
-@include install-old.texi
 
 @include extend.texi
 
diff -ruN doc.orig/include/fdl.texi doc/include/fdl.texi
--- doc.orig/include/fdl.texi	Tue Dec  4 09:16:52 2001
+++ doc/include/fdl.texi	Thu Dec  6 07:07:56 2001
@@ -17,7 +17,7 @@
 @ifset gfdlhtml
 @ifnothtml
 @comment node-name,     next,          previous, up
-@node    GNU Free Documentation License, Concept Index, Specific, Top
+@node    GNU Free Documentation License, Concept Index, Old, Top
 @end ifnothtml
 @html
 <h1 align="center">Installing GCC: GNU Free Documentation License</h1>
diff -ruN doc.orig/install-old.texi doc/install-old.texi
--- doc.orig/install-old.texi	Sun Nov 18 19:44:09 2001
+++ doc/install-old.texi	Fri Dec  7 11:52:49 2001
@@ -1,20 +1,30 @@
 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
 @c This is part of the GCC manual.
-@c For copying conditions, see the file gcc.texi.
+@c For copying conditions, see the file install.texi.
 
-@node Installation
-@chapter Installing GNU CC
-@cindex installing GNU CC
+@ifnothtml
+@comment node-name,     next,          previous, up
+@node    Old, GNU Free Documentation License, Specific, Top
+@end ifnothtml
+@html
+<h1 align="center">Old installation documentation</h1>
+@end html
+@ifnothtml
+@chapter Old installation documentation
+@end ifnothtml
 
 Note most of this information is out of date and superseded by the
-new GCC install manual @file{gcc/doc/install.texi}.  It is
-provided for historical reference only.
+previous chapters of this manual.  It is provided for historical
+reference only, because of a lack of volunteers to merge it into the
+main manual.
 
+@ifnothtml
 @menu
 * Configurations::    Configurations Supported by GNU CC.
 * Cross-Compiler::   Building and installing a cross-compiler.
 * VMS Install::   See below for installation on VMS.
 @end menu
+@end ifnothtml
 
 Here is the procedure for installing GNU CC on a GNU or Unix system.
 See @ref{VMS Install}, for VMS systems.
@@ -83,8 +93,13 @@
 
 @end enumerate
 
-@node Configurations
+@ifnothtml
+@node Configurations, Cross-Compiler, , Old
 @section Configurations Supported by GNU CC
+@end ifnothtml
+@html
+<h2>@anchor{Configurations}Configurations Supported by GNU CC</h2>
+@end html
 @cindex configurations supported by GNU CC
 
 Here are the possible CPU types:
@@ -192,8 +207,13 @@
 See @ref{VMS Install}, for details on how to install GNU CC on VMS@.
 @end table
 
-@node Cross-Compiler
+@ifnothtml
+@node Cross-Compiler, VMS Install, Configurations, Old
 @section Building and Installing a Cross-Compiler
+@end ifnothtml
+@html
+<h2>@anchor{Cross-Compiler}Building and Installing a Cross-Compiler</h2>
+@end html
 @cindex cross-compiler, installation
 
 GNU CC can function as a cross-compiler for many machines, but not all.
@@ -223,6 +243,7 @@
 cross-linker as well.  You also need header files and libraries suitable
 for the target machine that you can install on the host machine.
 
+@ifnothtml
 @menu
 * Steps of Cross::      Using a cross-compiler involves several steps
                           that may be carried out on different machines.
@@ -232,9 +253,15 @@
                           for a cross-compiler.
 * Build Cross::         Actually compiling the cross-compiler.
 @end menu
+@end ifnothtml
 
-@node Steps of Cross
+@ifnothtml
+@node Steps of Cross, Configure Cross, , Cross-Compiler
 @subsection Steps of Cross-Compilation
+@end ifnothtml
+@html
+<h2>Steps of Cross-Compilation</h2>
+@end html
 
 To compile and run a program using a cross-compiler involves several
 steps:
@@ -262,8 +289,13 @@
 requires a suitable cross-assembler and cross-linker.  For some targets,
 the GNU assembler and linker are available.
 
-@node Configure Cross
+@ifnothtml
+@node Configure Cross, Tools and Libraries, Steps of Cross, Cross-Compiler
 @subsection Configuring a Cross-Compiler
+@end ifnothtml
+@html
+<h2>Configuring a Cross-Compiler</h2>
+@end html
 
 To build GNU CC as a cross-compiler, you start out by running
 @file{configure}.  Use the @option{--target=@var{target}} to specify the
@@ -277,8 +309,13 @@
 ./configure --target=m68k-hp-bsd4.3
 @end smallexample
 
-@node Tools and Libraries
+@ifnothtml
+@node Tools and Libraries, Cross Headers, Configure Cross, Cross-Compiler
 @subsection Tools and Libraries for a Cross-Compiler
+@end ifnothtml
+@html
+<h2>Tools and Libraries for a Cross-Compiler</h2>
+@end html
 
 If you have a cross-assembler and cross-linker available, you should
 install them now.  Put them in the directory
@@ -353,8 +390,13 @@
 quit
 @end example
 
-@node Cross Headers
+@ifnothtml
+@node Cross Headers, Build Cross, Tools and Libraries, Cross-Compiler
 @subsection Cross-Compilers and Header Files
+@end ifnothtml
+@html
+<h2>Cross-Compilers and Header Files</h2>
+@end html
 
 If you are cross-compiling a standalone program or a program for an
 embedded system, then you may not need any header files except the few
@@ -405,8 +447,13 @@
 tar xf tarfile
 @end example
 
-@node Build Cross
+@ifnothtml
+@node Build Cross, , Cross Headers, Cross-Compiler
 @subsection Actually Building the Cross-Compiler
+@end ifnothtml
+@html
+<h2>Actually Building the Cross-Compiler</h2>
+@end html
 
 Now you can proceed just as for compiling a single-machine compiler
 through the step of building stage 1.
@@ -433,8 +480,13 @@
 
 To install the cross-compiler, use @samp{make install}, as usual.
 
-@node VMS Install
+@ifnothtml
+@node VMS Install, , Cross-Compiler, Old
 @section Installing GNU CC on VMS
+@end ifnothtml
+@html
+<h2>@anchor{VMS Install}Installing GNU CC on VMS</h2>
+@end html
 @cindex VMS installation
 @cindex installing GNU CC on VMS
 
diff -ruN doc.orig/install.texi doc/install.texi
--- doc.orig/install.texi	Tue Dec  4 09:18:05 2001
+++ doc/install.texi	Fri Dec  7 11:54:55 2001
@@ -32,6 +32,9 @@
 @ifset binarieshtml
 @settitle Installing GCC: Binaries
 @end ifset
+@ifset oldhtml
+@settitle Installing GCC: Old documentation
+@end ifset
 @ifset gfdlhtml
 @settitle Installing GCC: GNU Free Documentation License
 @end ifset
@@ -50,6 +53,7 @@
 @set testhtml
 @set finalinstallhtml
 @set binarieshtml
+@set oldhtml
 @set gfdlhtml
 @end ifnothtml
 
@@ -105,6 +109,8 @@
 * Specific::        Host/target specific installation notes for GCC.
 * Binaries::        Where to get pre-compiled binaries.
 
+* Old::             Old installation documentation.
+
 * GNU Free Documentation License:: How you can copy and share this manual.
 * Concept Index::   This index has two entries.
 @end menu
@@ -184,6 +190,12 @@
 any longer, and, if shared libraries are installed there as well, no
 more binaries exist that use them.
 
+@ifhtml
+There are also some @uref{old.html,,old installation instructions},
+which are mostly obsolete but still contain some information which has
+not yet been merged into the main part of this manual.
+@end ifhtml
+
 @html
 <hr>
 <p>
@@ -1389,7 +1401,7 @@
 @c ***Specific****************************************************************
 @ifnothtml
 @comment node-name,     next,          previous, up
-@node    Specific, GNU Free Documentation License, Binaries, Top
+@node    Specific, Old, Binaries, Top
 @end ifnothtml
 @ifset specifichtml
 @html
@@ -3675,6 +3687,19 @@
 automatically.
 
 
+@html
+</p>
+<hr>
+<p>
+@end html
+@ifhtml
+@uref{./index.html,,Return to the GCC Installation page}
+@end ifhtml
+@end ifset
+
+@c ***Old documentation******************************************************
+@ifset oldhtml
+@include install-old.texi
 @html
 </p>
 <hr>
diff -ruN doc.orig/install.texi2html doc/install.texi2html
--- doc.orig/install.texi2html	Tue Dec  4 09:16:52 2001
+++ doc/install.texi2html	Thu Dec  6 07:08:27 2001
@@ -22,7 +22,8 @@
 fi
 
 for x in index.html specific.html download.html configure.html \
-         build.html test.html finalinstall.html binaries.html gfdl.html
+         build.html test.html finalinstall.html binaries.html old.html \
+         gfdl.html
 do
     define=`echo $x | sed -e 's/\.//g'`
     echo "define = $define"

-- 
Joseph S. Myers
jsm28@cam.ac.uk


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