]> git.ipfire.org Git - thirdparty/glibc.git/blame - manual/install.texi
powerpc64le: Check for compiler features for float128
[thirdparty/glibc.git] / manual / install.texi
CommitLineData
1f77f049 1@include macros.texi
8b748aed 2@include pkgvers.texi
3c20b9b6 3
d136c6dc 4@ifclear plain
3d2abe79 5@node Installation, Maintenance, Library Summary, Top
d136c6dc
SP
6@end ifclear
7
1f77f049
JM
8@c %MENU% How to install the GNU C Library
9@appendix Installing @theglibc{}
3c20b9b6 10
7ac30cc5
AJ
11Before you do anything else, you should read the FAQ at
12@url{http://sourceware.org/glibc/wiki/FAQ}. It answers common
13questions and describes problems you may experience with compilation
14and installation.
3c20b9b6 15
1f77f049 16Features can be added to @theglibc{} via @dfn{add-on} bundles. These are
a4d62195 17separate tar files, which you unpack into the top level of the source
1792d4db 18tree. Then you give @code{configure} the @samp{--enable-add-ons} option
b3af1a24 19to activate them, and they will be compiled into the library.
00c1176b
UD
20
21You will need recent versions of several GNU tools: definitely GCC and
fe959e1e 22GNU Make, and possibly others. @xref{Tools for Compilation}, below.
00c1176b 23
ee0a148a 24@ifclear plain
00c1176b
UD
25@menu
26* Configuring and compiling:: How to compile and test GNU libc.
a4d62195
UD
27* Running make install:: How to install it once you've got it
28 compiled.
00c1176b 29* Tools for Compilation:: You'll need these first.
90d1d40b 30* Linux:: Specific advice for GNU/Linux systems.
00c1176b
UD
31* Reporting Bugs:: So they'll get fixed.
32@end menu
ee0a148a 33@end ifclear
00c1176b
UD
34
35@node Configuring and compiling
1f77f049 36@appendixsec Configuring and compiling @theglibc{}
1792d4db
UD
37@cindex configuring
38@cindex compiling
00c1176b 39
1f77f049 40@Theglibc{} cannot be compiled in the source directory. You must build
3858bf28 41it in a separate build directory. For example, if you have unpacked
1f77f049
JM
42the @glibcadj{} sources in @file{/src/gnu/glibc-@var{version}},
43create a directory
e8b1163e 44@file{/src/gnu/glibc-build} to put the object files in. This allows
3858bf28
RM
45removing the whole build directory in case an error occurs, which is
46the safest way to get a fresh start and should always be done.
00c1176b 47
a4d62195 48From your object directory, run the shell script @file{configure} located
00c1176b
UD
49at the top level of the source tree. In the scenario above, you'd type
50
51@smallexample
f1e86fca 52$ ../glibc-@var{version}/configure @var{args@dots{}}
00c1176b
UD
53@end smallexample
54
3858bf28 55Please note that even though you're building in a separate build
e6bdb741
AJ
56directory, the compilation may need to create or modify files and
57directories in the source directory.
f76d7052 58
00c1176b 59@noindent
3858bf28
RM
60@code{configure} takes many options, but the only one that is usually
61mandatory is @samp{--prefix}. This option tells @code{configure}
1f77f049 62where you want @theglibc{} installed. This defaults to @file{/usr/local},
3858bf28 63but the normal setting to install as the standard system library is
a7a93d50
JM
64@samp{--prefix=/usr} for @gnulinuxsystems{} and @samp{--prefix=} (an
65empty prefix) for @gnuhurdsystems{}.
00c1176b
UD
66
67It may also be useful to set the @var{CC} and @var{CFLAGS} variables in
68the environment when running @code{configure}. @var{CC} selects the C
69compiler that will be used, and @var{CFLAGS} sets optimization options
70for the compiler.
71
a4d62195
UD
72The following list describes all of the available options for
73 @code{configure}:
3c20b9b6
UD
74
75@table @samp
00c1176b
UD
76@item --prefix=@var{directory}
77Install machine-independent data files in subdirectories of
78@file{@var{directory}}. The default is to install in @file{/usr/local}.
79
80@item --exec-prefix=@var{directory}
81Install the library and other machine-dependent files in subdirectories
82of @file{@var{directory}}. The default is to the @samp{--prefix}
04b9968b 83directory if that option is specified, or @file{/usr/local} otherwise.
00c1176b
UD
84
85@item --with-headers=@var{directory}
86Look for kernel header files in @var{directory}, not
1f77f049
JM
87@file{/usr/include}. @Theglibc{} needs information from the kernel's header
88files describing the interface to the kernel. @Theglibc{} will normally
abd923db 89look in @file{/usr/include} for them,
04b9968b 90but if you specify this option, it will look in @var{DIRECTORY} instead.
00c1176b
UD
91
92This option is primarily of use on a system where the headers in
1f77f049 93@file{/usr/include} come from an older version of @theglibc{}. Conflicts can
02c4bbad 94occasionally happen in this case. You can also use this option if you want to
1f77f049 95compile @theglibc{} with a newer set of kernel headers than the ones found in
00c1176b
UD
96@file{/usr/include}.
97
98@item --enable-add-ons[=@var{list}]
3858bf28
RM
99Specify add-on packages to include in the build. If this option is
100specified with no list, it enables all the add-on packages it finds in
101the main source directory; this is the default behavior. You may
102specify an explicit list of add-ons to use in @var{list}, separated by
103spaces or commas (if you use spaces, remember to quote them from the
104shell). Each add-on in @var{list} can be an absolute directory name
105or can be a directory name relative to the main source directory, or
106relative to the build directory (that is, the current working directory).
f1e86fca 107For example, @samp{--enable-add-ons=nptl,../glibc-libidn-@var{version}}.
00c1176b 108
d2830ba4 109@item --enable-kernel=@var{version}
a7a93d50 110This option is currently only useful on @gnulinuxsystems{}. The
d2830ba4
UD
111@var{version} parameter should have the form X.Y.Z and describes the
112smallest version of the Linux kernel the generated library is expected
113to support. The higher the @var{version} number is, the less
114compatibility code is added, and the faster the code gets.
115
3c20b9b6
UD
116@item --with-binutils=@var{directory}
117Use the binutils (assembler and linker) in @file{@var{directory}}, not
a4d62195 118the ones the C compiler would default to. You can use this option if
3c20b9b6 119the default binutils on your system cannot deal with all the constructs
1f77f049 120in @theglibc{}. In that case, @code{configure} will detect the
a4d62195
UD
121problem and suppress these constructs, so that the library will still be
122usable, but functionality may be lost---for example, you can't build a
123shared libc with old binutils.
3c20b9b6 124
3c20b9b6 125@item --without-fp
3c20b9b6
UD
126Use this option if your computer lacks hardware floating-point support
127and your operating system does not emulate an FPU.
128
b5ca0fb0
UD
129@c disable static doesn't work currently
130@c @item --disable-static
fb06851d 131@c Don't build static libraries. Static libraries aren't that useful these
b5ca0fb0 132@c days, but we recommend you build them in case you need them.
3c20b9b6 133
00c1176b 134@item --disable-shared
a4d62195
UD
135Don't build shared libraries even if it is possible. Not all systems
136support shared libraries; you need ELF support and (currently) the GNU
137linker.
3c20b9b6 138
00c1176b
UD
139@item --disable-profile
140Don't build libraries with profiling information. You may want to use
141this option if you don't plan to do profiling.
f12944ec 142
00c1176b
UD
143@item --enable-static-nss
144Compile static versions of the NSS (Name Service Switch) libraries.
145This is not recommended because it defeats the purpose of NSS; a program
146linked statically with the NSS libraries cannot be dynamically
147reconfigured to use a different name database.
148
740b3dbe
L
149@item --enable-hardcoded-path-in-tests
150By default, dynamic tests are linked to run with the installed C library.
151This option hardcodes the newly built C library path in dynamic tests
152so that they can be invoked directly.
153
1cba4036
MF
154@item --disable-timezone-tools
155By default, timezone related utilities (@command{zic}, @command{zdump},
44f826e3 156and @command{tzselect}) are installed with @theglibc{}. If you are building
1cba4036 157these independently (e.g. by using the @samp{tzcode} package), then this
44f826e3 158option will allow disabling the install of these.
1cba4036
MF
159
160Note that you need to make sure the external tools are kept in sync with
161the versions that @theglibc{} expects as the data formats may change over
162time. Consult the @file{timezone} subdirectory for more details.
163
1717da59
AK
164@item --enable-lock-elision=yes
165Enable lock elision for pthread mutexes by default.
166
03baef1c
NA
167@item --enable-stack-protector
168@itemx --enable-stack-protector=strong
169@itemx --enable-stack-protector=all
170Compile the C library and all other parts of the glibc package
171(including the threading and math libraries, NSS modules, and
172transliteration modules) using the GCC @option{-fstack-protector},
173@option{-fstack-protector-strong} or @option{-fstack-protector-all}
174options to detect stack overruns. Only the dynamic linker and a small
175number of routines called directly from assembler are excluded from this
176protection.
177
2d6ab5df
FW
178@item --enable-bind-now
179Disable lazy binding for installed shared objects. This provides
180additional security hardening because it enables full RELRO and a
181read-only global offset table (GOT), at the cost of slightly increased
182program load times.
183
e4608715
CD
184@pindex pt_chown
185@findex grantpt
186@item --enable-pt_chown
187The file @file{pt_chown} is a helper binary for @code{grantpt}
188(@pxref{Allocation, Pseudo-Terminals}) that is installed setuid root to
189fix up pseudo-terminal ownership. It is not built by default because
190systems using the Linux kernel are commonly built with the @code{devpts}
191filesystem enabled and mounted at @file{/dev/pts}, which manages
192pseudo-terminal ownership automatically. By using
193@samp{--enable-pt_chown}, you may build @file{pt_chown} and install it
194setuid and owned by @code{root}. The use of @file{pt_chown} introduces
195additional security risks to the system and you should enable it only if
196you understand and accept those risks.
197
a4ecc9eb
JM
198@item --disable-werror
199By default, @theglibc{} is built with @option{-Werror}. If you wish
200to build without this option (for example, if building with a newer
201version of GCC than this version of @theglibc{} was tested with, so
202new warnings cause the build with @option{-Werror} to fail), you can
203configure with @option{--disable-werror}.
204
21933112 205@item --disable-mathvec
b55a155f
RJ
206By default for x86_64, @theglibc{} is built with the vector math library.
207Use this option to disable the vector math library.
21933112 208
67e58f39
SP
209@item --enable-tunables
210Tunables support allows additional library parameters to be customized at
2c0b90ab
SP
211runtime. This feature is enabled by default. This option can take the
212following values:
6765d5d3
SP
213
214@table @code
6765d5d3 215@item yes
2c0b90ab 216This is the default if no option is passed to configure. This enables tunables
6765d5d3
SP
217and selects the default frontend (currently @samp{valstring}).
218
2c0b90ab
SP
219@item no
220This option disables tunables.
221
6765d5d3
SP
222@item valstring
223This enables tunables and selects the @samp{valstring} frontend for tunables.
224This frontend allows users to specify tunables as a colon-separated list in a
225single environment variable @env{GLIBC_TUNABLES}.
226@end table
67e58f39 227
1e4d83f6
TK
228@item --enable-obsolete-nsl
229By default, libnsl is only built as shared library for backward
230compatibility and the NSS modules libnss_compat, libnss_nis and
231libnss_nisplus are not built at all.
232Use this option to enable libnsl with all depending NSS modules and
233header files.
234
00c1176b
UD
235@item --build=@var{build-system}
236@itemx --host=@var{host-system}
04b9968b 237These options are for cross-compiling. If you specify both options and
00c1176b 238@var{build-system} is different from @var{host-system}, @code{configure}
1f77f049 239will prepare to cross-compile @theglibc{} from @var{build-system} to be used
00c1176b
UD
240on @var{host-system}. You'll probably need the @samp{--with-headers}
241option too, and you may have to override @var{configure}'s selection of
242the compiler and/or binutils.
243
a4d62195
UD
244If you only specify @samp{--host}, @code{configure} will prepare for a
245native compile but use what you specify instead of guessing what your
cf822e3c 246system is. This is most useful to change the CPU submodel. For example,
e98cdb38
CD
247if @code{configure} guesses your machine as @code{i686-pc-linux-gnu} but
248you want to compile a library for 586es, give
249@samp{--host=i586-pc-linux-gnu} or just @samp{--host=i586-linux} and add
250the appropriate compiler flags (@samp{-mcpu=i586} will do the trick) to
a4d62195 251@var{CFLAGS}.
1792d4db 252
a4d62195 253If you specify just @samp{--build}, @code{configure} will get confused.
8b748aed
JM
254
255@item --with-pkgversion=@var{version}
256Specify a description, possibly including a build number or build
257date, of the binaries being built, to be included in
258@option{--version} output from programs installed with @theglibc{}.
259For example, @option{--with-pkgversion='FooBar GNU/Linux glibc build
260123'}. The default value is @samp{GNU libc}.
261
262@item --with-bugurl=@var{url}
263Specify the URL that users should visit if they wish to report a bug,
264to be included in @option{--help} output from programs installed with
265@theglibc{}. The default value refers to the main bug-reporting
266information for @theglibc{}.
3c20b9b6
UD
267@end table
268
00c1176b
UD
269To build the library and related programs, type @code{make}. This will
270produce a lot of output, some of which may look like errors from
b55a155f 271@code{make} but aren't. Look for error messages from @code{make}
a4d62195 272containing @samp{***}. Those indicate that something is seriously wrong.
00c1176b 273
3858bf28
RM
274The compilation process can take a long time, depending on the
275configuration and the speed of your machine. Some complex modules may
276take a very long time to compile, as much as several minutes on slower
277machines. Do not panic if the compiler appears to hang.
3c20b9b6 278
8eadd4f3
UD
279If you want to run a parallel make, simply pass the @samp{-j} option
280with an appropriate numeric parameter to @code{make}. You need a recent
281GNU @code{make} version, though.
f12944ec 282
04b9968b
UD
283To build and run test programs which exercise some of the library
284facilities, type @code{make check}. If it does not complete
285successfully, do not use the built library, and report a bug after
286verifying that the problem is not already known. @xref{Reporting Bugs},
287for instructions on reporting bugs. Note that some of the tests assume
288they are not being run by @code{root}. We recommend you compile and
1f77f049 289test @theglibc{} as an unprivileged user.
3c20b9b6 290
8eadd4f3 291Before reporting bugs make sure there is no problem with your system.
a4d62195 292The tests (and later installation) use some pre-existing files of the
8eadd4f3
UD
293system such as @file{/etc/passwd}, @file{/etc/nsswitch.conf} and others.
294These files must all contain correct and sensible content.
295
d6fe5e58
JM
296Normally, @code{make check} will run all the tests before reporting
297all problems found and exiting with error status if any problems
298occurred. You can specify @samp{stop-on-test-failure=y} when running
299@code{make check} to make the test run stop and exit with an error
300status immediately when a failure occurs.
301
23b5cae1
MG
302The @glibcadj{} pretty printers come with their own set of scripts for testing,
303which run together with the rest of the testsuite through @code{make check}.
304These scripts require the following tools to run successfully:
305
306@itemize @bullet
307@item
308Python 2.7.6/3.4.3 or later
309
310Python is required for running the printers' test scripts.
311
312@item PExpect 4.0
313
314The printer tests drive GDB through test programs and compare its output
315to the printers'. PExpect is used to capture the output of GDB, and should be
316compatible with the Python version in your system.
317
318@item
319GDB 7.8 or later with support for Python 2.7.6/3.4.3 or later
320
321GDB itself needs to be configured with Python support in order to use the
322pretty printers. Notice that your system having Python available doesn't imply
323that GDB supports it, nor that your system's Python and GDB's have the same
324version.
325@end itemize
326
327@noindent
328If these tools are absent, the printer tests will report themselves as
329@code{UNSUPPORTED}. Notice that some of the printer tests require @theglibc{}
330to be compiled with debugging symbols.
331
3c20b9b6 332To format the @cite{GNU C Library Reference Manual} for printing, type
6a4888ff
AJ
333@w{@code{make dvi}}. You need a working @TeX{} installation to do
334this. The distribution builds the on-line formatted version of the
335manual, as Info files, as part of the build process. You can build
336them manually with @w{@code{make info}}.
1792d4db 337
2e8048e5
UD
338The library has a number of special-purpose configuration parameters
339which you can find in @file{Makeconfig}. These can be overwritten with
340the file @file{configparms}. To change them, create a
341@file{configparms} in your build directory and add values as appropriate
342for your system. The file is included and parsed by @code{make} and has
343to follow the conventions for makefiles.
344
1f77f049 345It is easy to configure @theglibc{} for cross-compilation by
2e8048e5
UD
346setting a few variables in @file{configparms}. Set @code{CC} to the
347cross-compiler for the target you configured the library for; it is
348important to use this same @code{CC} value when running
349@code{configure}, like this: @samp{CC=@var{target}-gcc configure
a4d62195
UD
350@var{target}}. Set @code{BUILD_CC} to the compiler to use for programs
351run on the build system as part of compiling the library. You may need to
e9433893
UD
352set @code{AR} to cross-compiling versions of @code{ar}
353if the native tools are not configured to work with
df381762
JM
354object files for the target you configured for. When cross-compiling
355@theglibc{}, it may be tested using @samp{make check
356test-wrapper="@var{srcdir}/scripts/cross-test-ssh.sh @var{hostname}"},
357where @var{srcdir} is the absolute directory name for the main source
358directory and @var{hostname} is the host name of a system that can run
359the newly built binaries of @theglibc{}. The source and build
360directories must be visible at the same locations on both the build
361system and @var{hostname}.
2e8048e5 362
0eb69512
JM
363In general, when testing @theglibc{}, @samp{test-wrapper} may be set
364to the name and arguments of any program to run newly built binaries.
365This program must preserve the arguments to the binary being run, its
8540f6d2 366working directory and the standard input, output and error file
4acc27ed
RM
367descriptors. If @samp{@var{test-wrapper} env} will not work to run a
368program with environment variables set, then @samp{test-wrapper-env}
369must be set to a program that runs a newly built program with
370environment variable assignments in effect, those assignments being
371specified as @samp{@var{var}=@var{value}} before the name of the
372program to be run. If multiple assignments to the same variable are
373specified, the last assignment specified must take precedence.
374Similarly, if @samp{@var{test-wrapper} env -i} will not work to run a
375program with an environment completely empty of variables except those
376directly assigned, then @samp{test-wrapper-env-only} must be set; its
377use has the same syntax as @samp{test-wrapper-env}, the only
378difference in its semantics being starting with an empty set of
379environment variables rather than the ambient set.
0eb69512 380
2e8048e5 381
085320f5 382@node Running make install
1792d4db
UD
383@appendixsec Installing the C Library
384@cindex installing
3c20b9b6
UD
385
386To install the library and its header files, and the Info files of the
686554bf 387manual, type @code{make install}. This will
a4d62195 388build things, if necessary, before installing them; however, you should
1f77f049 389still compile everything first. If you are installing @theglibc{} as your
920e11e9
UD
390primary C library, we recommend that you shut the system down to
391single-user mode first, and reboot afterward. This minimizes the risk
392of breaking things when the library changes out from underneath.
1792d4db 393
02c4bbad 394@samp{make install} will do the entire job of upgrading from a
1f77f049
JM
395previous installation of @theglibc{} version 2.x. There may sometimes
396be headers
02c4bbad
JM
397left behind from the previous installation, but those are generally
398harmless. If you want to avoid leaving headers behind you can do
399things in the following order.
c559a3ca
UD
400
401You must first build the library (@samp{make}), optionally check it
402(@samp{make check}), switch the include directories and then install
403(@samp{make install}). The steps must be done in this order. Not moving
404the directory before install will result in an unusable mixture of header
405files from both libraries, but configuring, building, and checking the
406library requires the ability to compile and run programs against the old
02c4bbad
JM
407library. The new @file{/usr/include}, after switching the include
408directories and before installing the library should contain the Linux
409headers, but nothing else. If you do this, you will need to restore
1f77f049 410any headers from libraries other than @theglibc{} yourself after installing the
62075f0f 411library.
c559a3ca 412
a82a3db9
MS
413You can install @theglibc{} somewhere other than where you configured
414it to go by setting the @code{DESTDIR} GNU standard make variable on
415the command line for @samp{make install}. The value of this variable
416is prepended to all the paths for installation. This is useful when
417setting up a chroot environment or preparing a binary distribution.
418The directory should be specified with an absolute file name. Installing
419with the @code{prefix} and @code{exec_prefix} GNU standard make variables
420set is not supported.
1792d4db 421
1f77f049 422@Theglibc{} includes a daemon called @code{nscd}, which you
1792d4db
UD
423may or may not want to run. @code{nscd} caches name service lookups; it
424can dramatically improve performance with NIS+, and may help with DNS as
a0edd63e 425well.
1792d4db
UD
426
427One auxiliary program, @file{/usr/libexec/pt_chown}, is installed setuid
cdfc721b
AM
428@code{root} if the @samp{--enable-pt_chown} configuration option is used.
429This program is invoked by the @code{grantpt} function; it sets the
430permissions on a pseudoterminal so it can be used by the calling process.
431If you are using a Linux kernel with the @code{devpts} filesystem enabled
432and mounted at @file{/dev/pts}, you don't need this program.
3c20b9b6 433
d01d6319 434After installation you might want to configure the timezone and locale
1f77f049 435installation of your system. @Theglibc{} comes with a locale
d01d6319
UD
436database which gets configured with @code{localedef}. For example, to
437set up a German locale with name @code{de_DE}, simply issue the command
8fc1e2ca 438@samp{localedef -i de_DE -f ISO-8859-1 de_DE}. To configure all locales
1f77f049 439that are supported by @theglibc{}, you can issue from your build directory the
d01d6319
UD
440command @samp{make localedata/install-locales}.
441
a4d62195
UD
442To configure the locally used timezone, set the @code{TZ} environment
443variable. The script @code{tzselect} helps you to select the right value.
444As an example, for Germany, @code{tzselect} would tell you to use
445@samp{TZ='Europe/Berlin'}. For a system wide installation (the given
446paths are for an installation with @samp{--prefix=/usr}), link the
d01d6319
UD
447timezone file which is in @file{/usr/share/zoneinfo} to the file
448@file{/etc/localtime}. For Germany, you might execute @samp{ln -s
449/usr/share/zoneinfo/Europe/Berlin /etc/localtime}.
450
00c1176b
UD
451@node Tools for Compilation
452@appendixsec Recommended Tools for Compilation
3c20b9b6
UD
453@cindex installation tools
454@cindex tools, for installing library
455
456We recommend installing the following GNU tools before attempting to
1f77f049 457build @theglibc{}:
3c20b9b6
UD
458
459@itemize @bullet
460@item
2bbc70d5 461GNU @code{make} 3.79 or newer
3c20b9b6 462
1f77f049
JM
463You need the latest version of GNU @code{make}. Modifying @theglibc{}
464to work with other @code{make} programs would be so difficult that
a4d62195
UD
465we recommend you port GNU @code{make} instead. @strong{Really.} We
466recommend GNU @code{make} version 3.79. All earlier versions have severe
467bugs or lack features.
3c20b9b6
UD
468
469@item
4add8674 470GCC 4.9 or newer
0e7727f7 471
4add8674 472GCC 4.9 or higher is required. In general it is recommended to use
4863355a
JM
473the newest version of the compiler that is known to work for building
474@theglibc{}, as newer compilers usually produce better code. As of
ae7b8fbd 475release time, GCC 6.3 is the newest compiler verified to work to build
4863355a 476@theglibc{}.
91ea72b7 477
4efe3ce4
GG
478For PowerPC 64-bits little-endian (powerpc64le), GCC 6.2 or higher is
479required. This compiler version is the first to provide the features
480required for building @theglibc{} with support for @code{_Float128}.
481
022dfdce
SL
482For multi-arch support it is recommended to use a GCC which has been built with
483support for GNU indirect functions. This ensures that correct debugging
484information is generated for functions selected by IFUNC resolvers. This
485support can either be enabled by configuring GCC with
486@samp{--enable-gnu-indirect-function}, or by enabling it by default by setting
487@samp{default_gnu_indirect_function} variable for a particular architecture in
488the GCC source file @file{gcc/config.gcc}.
489
1f77f049
JM
490You can use whatever compiler you like to compile programs that use
491@theglibc{}.
3c20b9b6 492
90d1d40b 493Check the FAQ for any special compiler issues on particular platforms.
5713a71e 494
3c20b9b6 495@item
bd805071 496GNU @code{binutils} 2.22 or later
00c1176b 497
1f77f049 498You must use GNU @code{binutils} (as and ld) to build @theglibc{}.
0c02c85f 499No other assembler or linker has the necessary functionality at the
04cb913d
CD
500moment. As of release time, GNU @code{binutils} 2.25 is the newest
501verified to work to build @theglibc{}.
3c20b9b6
UD
502
503@item
3a12c70f 504GNU @code{texinfo} 4.7 or later
3c20b9b6
UD
505
506To correctly translate and install the Texinfo documentation you need
507this version of the @code{texinfo} package. Earlier versions do not
508understand all the tags used in the document, and the installation
1792d4db 509mechanism for the info files is not present or works differently.
2c8f75f7 510As of release time, @code{texinfo} 6.0 is the newest verified to work
04cb913d 511to build @theglibc{}.
3c20b9b6
UD
512
513@item
12086fb4 514GNU @code{awk} 3.1.2, or higher
00c1176b 515
12086fb4
RM
516@code{awk} is used in several places to generate files.
517Some @code{gawk} extensions are used, including the @code{asorti}
518function, which was introduced in version 3.1.2 of @code{gawk}.
2c8f75f7
CD
519As of release time, @code{gawk} version 4.1.3 is the newest verified
520to work to build @theglibc{}.
00c1176b
UD
521
522@item
523Perl 5
524
525Perl is not required, but it is used if present to test the
526installation. We may decide to use it elsewhere in the future.
3c20b9b6 527
d66732e0
UD
528@item
529GNU @code{sed} 3.02 or newer
530
a4d62195 531@code{Sed} is used in several places to generate files. Most scripts work
2c8f75f7
CD
532with any version of @code{sed}. As of release time, @code{sed} version
5334.2.2 is the newest verified to work to build @theglibc{}.
d66732e0 534
3c20b9b6
UD
535@end itemize
536
537@noindent
cb8a6dbd 538If you change any of the @file{configure.ac} files you will also need
3c20b9b6
UD
539
540@itemize @bullet
541@item
f3f5d895 542GNU @code{autoconf} 2.69 (exactly)
3c20b9b6
UD
543@end itemize
544
545@noindent
546and if you change any of the message translation files you will need
547
548@itemize @bullet
549@item
c26b4f64 550GNU @code{gettext} 0.10.36 or later
3c20b9b6
UD
551@end itemize
552
cc8623f1
WN
553@noindent
554If you wish to regenerate the @code{yacc} parser code in the @file{intl}
555subdirectory you will need
556
557@itemize @bullet
558@item
559GNU @code{bison} 2.7 or later
560@end itemize
561
3c20b9b6
UD
562@noindent
563You may also need these packages if you upgrade your source tree using
564patches, although we try to avoid this.
565
1792d4db 566@node Linux
a7a93d50 567@appendixsec Specific advice for @gnulinuxsystems{}
1792d4db
UD
568@cindex kernel header files
569
a7a93d50 570If you are installing @theglibc{} on @gnulinuxsystems{}, you need to have
5b4ecd3f 571the header files from a 3.2 or newer kernel around for reference.
e9203023
FW
572(For the ia64 architecture, you need version 3.2.18 or newer because this
573is the first version with support for the @code{accept4} system call.)
abd923db
JM
574These headers must be installed using @samp{make headers_install}; the
575headers present in the kernel source directory are not suitable for
1f77f049
JM
576direct use by @theglibc{}. You do not need to use that kernel, just have
577its headers installed where @theglibc{} can access them, referred to here as
abd923db
JM
578@var{install-directory}. The easiest way to do this is to unpack it
579in a directory such as @file{/usr/src/linux-@var{version}}. In that
580directory, run @samp{make headers_install
1f77f049 581INSTALL_HDR_PATH=@var{install-directory}}. Finally, configure @theglibc{}
abd923db
JM
582with the option @samp{--with-headers=@var{install-directory}/include}.
583Use the most recent kernel you can get your hands on. (If you are
1f77f049 584cross-compiling @theglibc{}, you need to specify
abd923db
JM
585@samp{ARCH=@var{architecture}} in the @samp{make headers_install}
586command, where @var{architecture} is the architecture name used by the
587Linux kernel, such as @samp{x86} or @samp{powerpc}.)
a8d87c92 588
1f77f049 589After installing @theglibc{}, you may need to remove or rename
abd923db
JM
590directories such as @file{/usr/include/linux} and
591@file{/usr/include/asm}, and replace them with copies of directories
592such as @file{linux} and @file{asm} from
593@file{@var{install-directory}/include}. All directories present in
594@file{@var{install-directory}/include} should be copied, except that
1f77f049 595@theglibc{} provides its own version of @file{/usr/include/scsi}; the
abd923db 596files provided by the kernel should be copied without replacing those
1f77f049 597provided by @theglibc{}. The @file{linux}, @file{asm} and
abd923db 598@file{asm-generic} directories are required to compile programs using
1f77f049 599@theglibc{}; the other directories describe interfaces to the kernel but
abd923db
JM
600are not required if not compiling programs using those interfaces.
601You do not need to copy kernel headers if you did not specify an
602alternate kernel header source using @samp{--with-headers}.
1792d4db 603
a7a93d50
JM
604The Filesystem Hierarchy Standard for @gnulinuxsystems{} expects some
605components of the @glibcadj{} installation to be in
1792d4db 606@file{/lib} and some in @file{/usr/lib}. This is handled automatically
1f77f049 607if you configure @theglibc{} with @samp{--prefix=/usr}. If you set some other
1792d4db
UD
608prefix or allow it to default to @file{/usr/local}, then all the
609components are installed there.
610
3c20b9b6
UD
611@node Reporting Bugs
612@appendixsec Reporting Bugs
613@cindex reporting bugs
614@cindex bugs, reporting
615
1f77f049 616There are probably bugs in @theglibc{}. There are certainly
3c20b9b6
UD
617errors and omissions in this manual. If you report them, they will get
618fixed. If you don't, no one will ever know about them and they will
619remain unfixed for all eternity, if not longer.
620
04b9968b
UD
621It is a good idea to verify that the problem has not already been
622reported. Bugs are documented in two places: The file @file{BUGS}
8b748aed
JM
623describes a number of well known bugs and the central @glibcadj{}
624bug tracking system has a
612fdf25 625WWW interface at
c0ed9d7d 626@url{http://sourceware.org/bugzilla/}. The WWW
a4d62195
UD
627interface gives you access to open and closed reports. A closed report
628normally includes a patch or a hint on solving the problem.
612fdf25 629
a4d62195 630To report a bug, first you must find it. With any luck, this will be the
3c20b9b6 631hard part. Once you've found a bug, make sure it's really a bug. A
1f77f049 632good way to do this is to see if @theglibc{} behaves the same way
3c20b9b6
UD
633some other C library does. If so, probably you are wrong and the
634libraries are right (but not necessarily). If not, one of the libraries
1f77f049 635is probably wrong. It might not be @theglibc{}. Many historical
1792d4db
UD
636Unix C libraries permit things that we don't, such as closing a file
637twice.
638
1f77f049 639If you think you have found some way in which @theglibc{} does not
1792d4db
UD
640conform to the ISO and POSIX standards (@pxref{Standards and
641Portability}), that is definitely a bug. Report it!
3c20b9b6
UD
642
643Once you're sure you've found a bug, try to narrow it down to the
644smallest test case that reproduces the problem. In the case of a C
645library, you really only need to narrow it down to one library
646function call, if possible. This should not be too difficult.
647
648The final step when you have a simple test case is to report the bug.
8b748aed 649Do this at @value{REPORT_BUGS_TO}.
3c20b9b6
UD
650
651If you are not sure how a function should behave, and this manual
652doesn't tell you, that's a bug in the manual. Report that too! If the
653function's behavior disagrees with the manual, then either the library
654or the manual has a bug, so report the disagreement. If you find any
d40eb37a
UD
655errors or omissions in this manual, please report them to the
656bug database. If you refer to specific
04b9968b
UD
657sections of the manual, please include the section names for easier
658identification.