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]

Patch to move some installation documentation


This patch moves some documentation from the old install manual to the
new one.  It passes "make info" and "make dvi".  OK to commit?

2001-06-02  Joseph S. Myers  <jsm28@cam.ac.uk>

	* doc/install-old.texi: Remove documentation of some configuration
	options.
	* doc/install.texi: Add relevant parts of this documentation here.

--- install-old.texi.orig	Fri Jun  1 16:51:18 2001
+++ install-old.texi	Sat Jun  2 13:02:29 2001
@@ -201,27 +201,6 @@
 effect, though perhaps there are other systems where it could usefully
 make a difference.
 
-@cindex Haifa scheduler
-@cindex scheduler, experimental
-@item --enable-haifa
-@itemx --disable-haifa
-Use @samp{--enable-haifa} to enable use of an experimental instruction
-scheduler (from IBM Haifa).  This may or may not produce better code.
-Some targets on which it is known to be a win enable it by default; use
-@samp{--disable-haifa} to disable it in these cases.  @code{configure}
-will print out whether the Haifa scheduler is enabled when it is run.
-
-@cindex Objective C threads
-@cindex threads, Objective C
-@item --enable-threads=@var{type}
-Certain systems, notably Linux-based GNU systems, can't be relied on to
-supply a threads facility for the Objective C runtime and so will
-default to single-threaded runtime.  They may, however, have a library
-threads implementation available, in which case threads can be enabled
-with this option by supplying a suitable @var{type}, probably
-@samp{posix}.  The possibilities for @var{type} are @samp{single},
-@samp{posix}, @samp{win32}, @samp{solaris}, @samp{irix} and @samp{mach}.
-
 @cindex Internal Compiler Checking
 @item --enable-checking
 When you specify this option, the compiler is built to perform checking
@@ -254,15 +233,6 @@
 @code{gettext} library.  The @samp{--with-catgets} option causes the
 build procedure to use the host's @code{catgets} in this situation.
 
-@cindex @code{maintainer-mode}
-@item --enable-maintainer-mode
-The build rules that regenerate the GCC master message catalog
-@code{gcc.pot} are normally disabled. This is because it can only be rebuilt
-if the complete source tree is present. If you have changed the sources and
-want to rebuild the catalog, configuring with
-@samp{--enable-maintainer-mode} will enable this. Note that you need a
-special version of the @code{gettext} tools to do so.
-
 @cindex Windows32 Registry support
 @item --enable-win32-registry
 @itemx --enable-win32-registry=@var{KEY}
@@ -282,54 +252,6 @@
 by default, and can be disabled by @code{--disable-win32-registry}
 option.  This option has no effect on the other hosts.
 @end table
-
-@item
-In certain cases, you should specify certain other options when you run
-@code{configure}.
-
-@itemize @bullet
-@item
-The standard directory for installing GNU CC is @file{/usr/local/lib}.
-If you want to install its files somewhere else, specify
-@samp{--prefix=@var{dir}} when you run @file{configure}.  Here @var{dir}
-is a directory name to use instead of @file{/usr/local} for all purposes
-with one exception: the directory @file{/usr/local/include} is searched
-for header files no matter where you install the compiler.  To override
-this name, use the @code{--with-local-prefix} option below.  The directory
-you specify need not exist, but its parent directory must exist.
-
-@item
-Specify @samp{--with-local-prefix=@var{dir}} if you want the compiler to
-search directory @file{@var{dir}/include} for locally installed header
-files @emph{instead} of @file{/usr/local/include}.
-
-You should specify @samp{--with-local-prefix} @strong{only} if your site has
-a different convention (not @file{/usr/local}) for where to put
-site-specific files.
-
-The default value for @samp{--with-local-prefix} is @file{/usr/local}
-regardless of the value of @samp{--prefix}.  Specifying @samp{--prefix}
-has no effect on which directory GNU CC searches for local header files.
-This may seem counterintuitive, but actually it is logical.
-
-The purpose of @samp{--prefix} is to specify where to @emph{install GNU
-CC}.  The local header files in @file{/usr/local/include}---if you put
-any in that directory---are not part of GNU CC.  They are part of other
-programs---perhaps many others.  (GNU CC installs its own header files
-in another directory which is based on the @samp{--prefix} value.)
-
-@strong{Do not} specify @file{/usr} as the @samp{--with-local-prefix}!  The
-directory you use for @samp{--with-local-prefix} @strong{must not} contain
-any of the system's standard header files.  If it did contain them,
-certain programs would be miscompiled (including GNU Emacs, on certain
-targets), because this would override and nullify the header file
-corrections made by the @code{fixincludes} script.
-
-Indications are that people who use this option use it based on
-mistaken ideas of what it is for.  People use it as if it specified
-where to install part of GNU CC.  Perhaps they make this assumption
-because installing GNU CC creates the directory.
-@end itemize
 
 @item
 Build the compiler.  Just type @samp{make LANGUAGES=c} in the compiler
--- install.texi.orig	Fri Jun  1 21:58:39 2001
+++ install.texi	Sat Jun  2 13:02:26 2001
@@ -297,9 +297,6 @@
 These additional options control where certain parts of the distribution
 are installed.  Normally you should not need to use these options.
 @itemize @bullet
-@item
-@option{--with-local-prefix=}@var{dirname} @minus{}@minus{} Specify the installation
-directory for local include files.  The default is @file{/usr/local}.
 
 @item
 @option{--with-gxx-include-dir=}@var{dirname} @minus{}@minus{} Specify
@@ -309,6 +306,41 @@
 @end itemize
 
 @item
+@option{--with-local-prefix=}@var{dirname} @minus{}@minus{} Specify the
+installation directory for local include files.  The default is
+@file{/usr/local}.  Specify this option if you want the compiler to
+search directory @file{@var{dirname}/include} for locally installed
+header files @emph{instead} of @file{/usr/local/include}.
+
+You should specify @option{--with-local-prefix} @strong{only} if your
+site has a different convention (not @file{/usr/local}) for where to put
+site-specific files.
+
+The default value for @option{--with-local-prefix} is @file{/usr/local}
+regardless of the value of @option{--prefix}.  Specifying
+@option{--prefix} has no effect on which directory GCC searches for
+local header files.  This may seem counterintuitive, but actually it is
+logical.
+
+The purpose of @option{--prefix} is to specify where to @emph{install
+GCC}.  The local header files in @file{/usr/local/include}---if you put
+any in that directory---are not part of GCC.  They are part of other
+programs---perhaps many others.  (GCC installs its own header files in
+another directory which is based on the @option{--prefix} value.)
+
+@strong{Do not} specify @file{/usr} as the @option{--with-local-prefix}!
+The directory you use for @option{--with-local-prefix} @strong{must not}
+contain any of the system's standard header files.  If it did contain
+them, certain programs would be miscompiled (including GNU Emacs, on
+certain targets), because this would override and nullify the header
+file corrections made by the @code{fixincludes} script.
+
+Indications are that people who use this option use it based on mistaken
+ideas of what it is for.  People use it as if it specified where to
+install part of GCC.  Perhaps they make this assumption because
+installing GCC creates the directory.
+
+@item
 @option{--enable-shared} @minus{}@minus{} Build shared versions of the
 C++ runtime libraries if supported. This is the default on most
 systems. Use @option{--disable-shared} for static libraries. Note that
@@ -375,12 +407,16 @@
 @option{--enable-threads} @minus{}@minus{} Specify that the target
 supports threads.  This affects the Objective-C compiler and runtime
 library, and exception handling for other languages like C++ and Java.
+On some systems, this is the default.
 
 @item
 @option{--enable-threads=}@var{lib} @minus{}@minus{} Specify that
 @var{lib} is the thread support library.  This affects the Objective-C
 compiler and runtime library, and exception handling for other languages
-like C++ and Java.
+like C++ and Java.  The possibilities for @var{lib} are @samp{aix},
+@samp{dce}, @samp{decosf1}, @samp{irix}, @samp{mach}, @samp{os2},
+@samp{posix}, @samp{pthreads}, @samp{single}, @samp{solaris},
+@samp{vxworks} and @samp{win32}.
 
 @item
 @option{--with-cpu=}@var{cpu} @minus{}@minus{} Specify which cpu variant the
@@ -405,6 +441,15 @@
 not supported by snapshots since November 2000.  In snapshots where
 it is supported, it is not enabled by default, except for snapshots
 very close to November 2000.
+
+@item
+@option{--enable-maintainer-mode} @minus{}@minus{} The build rules that
+regenerate the GCC master message catalog @code{gcc.pot} are normally
+disabled. This is because it can only be rebuilt if the complete source
+tree is present. If you have changed the sources and want to rebuild the
+catalog, configuring with @option{--enable-maintainer-mode} will enable
+this. Note that you need a recent version of the @code{gettext} tools
+to do so.
 
 @item
 @option{--without-fast-fixincludes} @minus{}@minus{} Specify that the

-- 
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]