summary refs log tree commit diff
path: root/manual
diff options
context:
space:
mode:
authorRoland McGrath <roland@gnu.org>2006-03-06 10:59:43 +0000
committerRoland McGrath <roland@gnu.org>2006-03-06 10:59:43 +0000
commit3858bf28a66f449cc2d815122032a60cf9bf793e (patch)
tree280ca2fcf92f8a2b01f7d5c1aaeef093c21954e1 /manual
parent6f920003899406055edfeb403989ce9215b34068 (diff)
downloadglibc-3858bf28a66f449cc2d815122032a60cf9bf793e.tar.gz
glibc-3858bf28a66f449cc2d815122032a60cf9bf793e.tar.xz
glibc-3858bf28a66f449cc2d815122032a60cf9bf793e.zip
	* README.template: Update for 2.4.
	* README: Regenerated.
	* manual/install.texi (Configuring and compiling): Separate build
	directory is mandatory.  Use glibc-2.4 in example.
	Update --enable-add-ons description.
	(Supported Configurations): Remove section.
	* INSTALL: Regenerated.
Diffstat (limited to 'manual')
-rw-r--r--manual/install.texi135
1 files changed, 27 insertions, 108 deletions
diff --git a/manual/install.texi b/manual/install.texi
index d9dace916b..0cd4d622de 100644
--- a/manual/install.texi
+++ b/manual/install.texi
@@ -24,7 +24,6 @@ GNU Make, and possibly others.  @xref{Tools for Compilation}, below.
 * Running make install::        How to install it once you've got it
  compiled.
 * Tools for Compilation::       You'll need these first.
-* Supported Configurations::    What it runs on, what it doesn't.
 * Linux::                       Specific advice for GNU/Linux systems.
 * Reporting Bugs::              So they'll get fixed.
 @end menu
@@ -34,34 +33,31 @@ GNU Make, and possibly others.  @xref{Tools for Compilation}, below.
 @cindex configuring
 @cindex compiling
 
-GNU libc can be compiled in the source directory, but we strongly advise
-building it in a separate build directory.  For example, if you have
- unpacked
-the glibc sources in @file{/src/gnu/glibc-2.3}, create a directory
+GNU libc cannot be compiled in the source directory.  You must build
+it in a separate build directory.  For example, if you have unpacked
+the glibc sources in @file{/src/gnu/glibc-2.4}, create a directory
 @file{/src/gnu/glibc-build} to put the object files in.  This allows
-removing the whole build directory in case an error occurs, which is the
-safest way to get a fresh start and should always be done.
+removing the whole build directory in case an error occurs, which is
+the safest way to get a fresh start and should always be done.
 
 From your object directory, run the shell script @file{configure} located
 at the top level of the source tree.  In the scenario above, you'd type
 
 @smallexample
-$ ../glibc-2.3/configure @var{args@dots{}}
+$ ../glibc-2.4/configure @var{args@dots{}}
 @end smallexample
 
-Please note that even if you're building in a separate build directory,
-the compilation needs to modify a few files in the source
+Please note that even though you're building in a separate build
+directory, the compilation needs to modify a few files in the source
 directory, especially some files in the manual subdirectory.
 
 @noindent
-@code{configure} takes many options, but you can get away with knowing
-only two: @samp{--prefix} and @samp{--enable-add-ons}.  The
-@code{--prefix} option tells @code{configure} where you want glibc
-installed. This defaults to @file{/usr/local}.  The
-@samp{--enable-add-ons} option tells @code{configure} to use all the
-add-on bundles it finds in the source directory.  Since important
-functionality is provided in add-ons, you should always specify this
-option.
+@code{configure} takes many options, but the only one that is usually
+mandatory is @samp{--prefix}.  This option tells @code{configure}
+where you want glibc installed.  This defaults to @file{/usr/local},
+but the normal setting to install as the standard system library is
+@samp{--prefix=/usr} for GNU/Linux systems and @samp{--prefix=} (an
+empty prefix) for GNU/Hurd systems.
 
 It may also be useful to set the @var{CC} and @var{CFLAGS} variables in
 the environment when running @code{configure}.  @var{CC} selects the C
@@ -95,11 +91,15 @@ compile glibc with a newer set of kernel headers than the ones found in
 @file{/usr/include}.
 
 @item --enable-add-ons[=@var{list}]
-Enable add-on packages in your source tree.  If this option is specified
-with no list, it enables all the add-on packages it finds.  If you do
-not wish to use some add-on packages that you have present in your source
-tree, give this option a list of the add-ons that you @emph{do} want
-used, like this: @samp{--enable-add-ons=nptl}
+Specify add-on packages to include in the build.  If this option is
+specified with no list, it enables all the add-on packages it finds in
+the main source directory; this is the default behavior.  You may
+specify an explicit list of add-ons to use in @var{list}, separated by
+spaces or commas (if you use spaces, remember to quote them from the
+shell).  Each add-on in @var{list} can be an absolute directory name
+or can be a directory name relative to the main source directory, or
+relative to the build directory (that is, the current working directory).
+For example, @samp{--enable-add-ons=nptl,../glibc-libidn-2.4}.
 
 @item --enable-kernel=@var{version}
 This option is currently only useful on GNU/Linux systems.  The
@@ -186,11 +186,10 @@ produce a lot of output, some of which may look like errors from
 @code{make} but isn't.  Look for error messages from @code{make}
 containing @samp{***}.  Those indicate that something is seriously wrong.
 
-The compilation process can take several hours.  Expect at least two
-hours for the default configuration on i586 for GNU/Linux.  For Hurd,
-times are much longer.  Some complex modules may take a very long time
-to compile, as much as several minutes on slower machines.  Do not
-panic if the compiler appears to hang.
+The compilation process can take a long time, depending on the
+configuration and the speed of your machine.  Some complex modules may
+take a very long time to compile, as much as several minutes on slower
+machines.  Do not panic if the compiler appears to hang.
 
 If you want to run a parallel make, simply pass the @samp{-j} option
 with an appropriate numeric parameter to @code{make}.  You need a recent
@@ -407,86 +406,6 @@ GNU @code{gettext} 0.10.36 or later
 You may also need these packages if you upgrade your source tree using
 patches, although we try to avoid this.
 
-@node Supported Configurations
-@appendixsec Supported Configurations
-@cindex configurations, all supported
-
-The GNU C Library currently supports configurations that match the
-following patterns:
-
-@smallexample
-alpha@var{*}-@var{*}-linux
-arm-@var{*}-linux
-cris-@var{*}-linux
-hppa-@var{*}-linux
-i@var{x}86-@var{*}-gnu
-i@var{x}86-@var{*}-linux
-ia64-@var{*}-linux
-m68k-@var{*}-linux
-mips@var{*}-@var{*}-linux
-powerpc-@var{*}-linux
-s390-@var{*}-linux
-s390x-@var{*}-linux
-sparc-@var{*}-linux
-sparc64-@var{*}-linux
-x86_64-@var{*}-linux
-@end smallexample
-
-Former releases of this library (version 2.1 and/or 2.0) used to run on
-the following configurations:
-
-@smallexample
-arm-@var{*}-linuxaout
-arm-@var{*}-none
-@end smallexample
-
-Very early releases (version 1.09.1 and perhaps earlier versions) used
-to run on the following configurations:
-
-@smallexample
-alpha-dec-osf1
-alpha-@var{*}-linuxecoff
-i@var{x}86-@var{*}-bsd4.3
-i@var{x}86-@var{*}-isc2.2
-i@var{x}86-@var{*}-isc3.@var{n}
-i@var{x}86-@var{*}-sco3.2
-i@var{x}86-@var{*}-sco3.2v4
-i@var{x}86-@var{*}-sysv
-i@var{x}86-@var{*}-sysv4
-i@var{x}86-force_cpu386-none
-i@var{x}86-sequent-bsd
-i960-nindy960-none
-m68k-hp-bsd4.3
-m68k-mvme135-none
-m68k-mvme136-none
-m68k-sony-newsos3
-m68k-sony-newsos4
-m68k-sun-sunos4.@var{n}
-mips-dec-ultrix4.@var{n}
-mips-sgi-irix4.@var{n}
-sparc-sun-solaris2.@var{n}
-sparc-sun-sunos4.@var{n}
-@end smallexample
-
-Since no one has volunteered to test and fix these configurations,
-they are not supported at the moment.  They probably don't compile;
-they definitely don't work anymore.  Porting the library is not hard.
-If you are interested in doing a port, please contact the glibc
-maintainers.  Start at @url{http://www.gnu.org/software/libc/} and
-read the references there on how to go about getting involved and
-contacting the developers.
-
-Valid cases of @samp{i@var{x}86} include @samp{i386}, @samp{i486},
-@samp{i586}, and @samp{i686}.  All of those configurations produce a
-library that can run on this processor and newer processors.  The GCC
-compiler by default generates code that's optimized for the machine it's
-configured for and will use the instructions available on that machine.
-For example if your GCC is configured for @samp{i686}, gcc will optimize
-for @samp{i686} and might issue some @samp{i686} specific instructions.
-To generate code for other models, you have to configure for that model
-and give GCC the appropriate @samp{-march=} and @samp{-mcpu=} compiler
-switches via @var{CFLAGS}.
-
 @node Linux
 @appendixsec Specific advice for GNU/Linux systems
 @cindex upgrading from libc5