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