Fix stringop-overflow warning in test-strncat.
[glibc.git] / INSTALL
blob970d6627e28012fdc3a7dd4a9123d46a80ffaebb
1 Installing the GNU C Library
2 ****************************
4 Before you do anything else, you should read the FAQ at
5 <https://sourceware.org/glibc/wiki/FAQ>.  It answers common questions
6 and describes problems you may experience with compilation and
7 installation.
9    You will need recent versions of several GNU tools: definitely GCC
10 and GNU Make, and possibly others.  *Note Tools for Compilation::,
11 below.
13 Configuring and compiling the GNU C Library
14 ===========================================
16 The GNU C Library cannot be compiled in the source directory.  You must
17 build it in a separate build directory.  For example, if you have
18 unpacked the GNU C Library sources in '/src/gnu/glibc-VERSION', create a
19 directory '/src/gnu/glibc-build' to put the object files in.  This
20 allows removing the whole build directory in case an error occurs, which
21 is the safest way to get a fresh start and should always be done.
23    From your object directory, run the shell script 'configure' located
24 at the top level of the source tree.  In the scenario above, you'd type
26      $ ../glibc-VERSION/configure ARGS...
28    Please note that even though you're building in a separate build
29 directory, the compilation may need to create or modify files and
30 directories in the source directory.
32 'configure' takes many options, but the only one that is usually
33 mandatory is '--prefix'.  This option tells 'configure' where you want
34 the GNU C Library installed.  This defaults to '/usr/local', but the
35 normal setting to install as the standard system library is
36 '--prefix=/usr' for GNU/Linux systems and '--prefix=' (an empty prefix)
37 for GNU/Hurd systems.
39    It may also be useful to pass 'CC=COMPILER' and 'CFLAGS=FLAGS'
40 arguments to 'configure'.  'CC' selects the C compiler that will be
41 used, and 'CFLAGS' sets optimization options for the compiler.  Any
42 compiler options required for all compilations, such as options
43 selecting an ABI or a processor for which to generate code, should be
44 included in 'CC'.  Options that may be overridden by the GNU C Library
45 build system for particular files, such as for optimization and
46 debugging, should go in 'CFLAGS'.  The default value of 'CFLAGS' is '-g
47 -O2', and the GNU C Library cannot be compiled without optimization, so
48 if 'CFLAGS' is specified it must enable optimization.  For example:
50      $ ../glibc-VERSION/configure CC="gcc -m32" CFLAGS="-O3"
52    The following list describes all of the available options for
53 'configure':
55 '--prefix=DIRECTORY'
56      Install machine-independent data files in subdirectories of
57      'DIRECTORY'.  The default is to install in '/usr/local'.
59 '--exec-prefix=DIRECTORY'
60      Install the library and other machine-dependent files in
61      subdirectories of 'DIRECTORY'.  The default is to the '--prefix'
62      directory if that option is specified, or '/usr/local' otherwise.
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
67      describing the interface to the kernel.  The GNU C Library will
68      normally look in '/usr/include' for them, but if you specify this
69      option, it will look in DIRECTORY instead.
71      This option is primarily of use on a system where the headers in
72      '/usr/include' come from an older version of the GNU C Library.
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
75      set of kernel headers than the ones found in '/usr/include'.
77 '--enable-kernel=VERSION'
78      This option is currently only useful on GNU/Linux systems.  The
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.
84 '--with-binutils=DIRECTORY'
85      Use the binutils (assembler and linker) in 'DIRECTORY', not the
86      ones the C compiler would default to.  You can use this option if
87      the default binutils on your system cannot deal with all the
88      constructs in the GNU C Library.  In that case, 'configure' will
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.
93 '--with-default-link'
94      With '--with-default-link', the build system does not use a custom
95      linker script for linking shared objects.  The default is
96      '--without-default-link', because the custom linker script is
97      needed for full RELRO protection.
99 '--with-nonshared-cflags=CFLAGS'
100      Use additional compiler flags CFLAGS to build the parts of the
101      library which are always statically linked into applications and
102      libraries even with shared linking (that is, the object files
103      contained in 'lib*_nonshared.a' libraries).  The build process will
104      automatically use the appropriate flags, but this option can be
105      used to set additional flags required for building applications and
106      libraries, to match local policy.  For example, if such a policy
107      requires that all code linked into applications must be built with
108      source fortification,
109      '--with-nonshared-cflags=-Wp,-D_FORTIFY_SOURCE=2' will make sure
110      that the objects in 'libc_nonshared.a' are compiled with this flag
111      (although this will not affect the generated code in this
112      particular case and potentially change debugging information and
113      metadata only).
115 '--with-rtld-early-cflags=CFLAGS'
116      Use additional compiler flags CFLAGS to build the early startup
117      code of the dynamic linker.  These flags can be used to enable
118      early dynamic linker diagnostics to run on CPUs which are not
119      compatible with the rest of the GNU C Library, for example, due to
120      compiler flags which target a later instruction set architecture
121      (ISA).
123 '--with-timeoutfactor=NUM'
124      Specify an integer NUM to scale the timeout of test programs.  This
125      factor can be changed at run time using 'TIMEOUTFACTOR' environment
126      variable.
128 '--disable-shared'
129      Don't build shared libraries even if it is possible.  Not all
130      systems support shared libraries; you need ELF support and
131      (currently) the GNU linker.
133 '--disable-default-pie'
134      Don't build glibc programs and the testsuite as position
135      independent executables (PIE). By default, glibc programs and tests
136      are created as position independent executables on targets that
137      support it.  If the toolchain and architecture support it, static
138      executables are built as static PIE and the resulting glibc can be
139      used with the GCC option, -static-pie, which is available with GCC
140      8 or above, to create static PIE.
142 '--enable-cet'
143 '--enable-cet=permissive'
144      Enable Intel Control-flow Enforcement Technology (CET) support.
145      When the GNU C Library is built with '--enable-cet' or
146      '--enable-cet=permissive', the resulting library is protected with
147      indirect branch tracking (IBT) and shadow stack (SHSTK).  When CET
148      is enabled, the GNU C Library is compatible with all existing
149      executables and shared libraries.  This feature is currently
150      supported on i386, x86_64 and x32 with GCC 8 and binutils 2.29 or
151      later.  Note that when CET is enabled, the GNU C Library requires
152      CPUs capable of multi-byte NOPs, like x86-64 processors as well as
153      Intel Pentium Pro or newer.  With '--enable-cet', it is an error to
154      dlopen a non CET enabled shared library in CET enabled application.
155      With '--enable-cet=permissive', CET is disabled when dlopening a
156      non CET enabled shared library in CET enabled application.
158      NOTE: '--enable-cet' has been tested for i686, x86_64 and x32 on
159      non-CET processors.  '--enable-cet' has been tested for i686,
160      x86_64 and x32 on CET processors.
162 '--enable-memory-tagging'
163      Enable memory tagging support if the architecture supports it.
164      When the GNU C Library is built with this option then the resulting
165      library will be able to control the use of tagged memory when
166      hardware support is present by use of the tunable
167      'glibc.mem.tagging'.  This includes the generation of tagged memory
168      when using the 'malloc' APIs.
170      At present only AArch64 platforms with MTE provide this
171      functionality, although the library will still operate (without
172      memory tagging) on older versions of the architecture.
174      The default is to disable support for memory tagging.
176 '--disable-profile'
177      Don't build libraries with profiling information.  You may want to
178      use this option if you don't plan to do profiling.
180 '--enable-static-nss'
181      Compile static versions of the NSS (Name Service Switch) libraries.
182      This is not recommended because it defeats the purpose of NSS; a
183      program linked statically with the NSS libraries cannot be
184      dynamically reconfigured to use a different name database.
186 '--enable-hardcoded-path-in-tests'
187      By default, dynamic tests are linked to run with the installed C
188      library.  This option hardcodes the newly built C library path in
189      dynamic tests so that they can be invoked directly.
191 '--disable-timezone-tools'
192      By default, timezone related utilities ('zic', 'zdump', and
193      'tzselect') are installed with the GNU C Library.  If you are
194      building these independently (e.g.  by using the 'tzcode' package),
195      then this option will allow disabling the install of these.
197      Note that you need to make sure the external tools are kept in sync
198      with the versions that the GNU C Library expects as the data
199      formats may change over time.  Consult the 'timezone' subdirectory
200      for more details.
202 '--enable-stack-protector'
203 '--enable-stack-protector=strong'
204 '--enable-stack-protector=all'
205      Compile the C library and all other parts of the glibc package
206      (including the threading and math libraries, NSS modules, and
207      transliteration modules) using the GCC '-fstack-protector',
208      '-fstack-protector-strong' or '-fstack-protector-all' options to
209      detect stack overruns.  Only the dynamic linker and a small number
210      of routines called directly from assembler are excluded from this
211      protection.
213 '--enable-bind-now'
214      Disable lazy binding for installed shared objects and programs.
215      This provides additional security hardening because it enables full
216      RELRO and a read-only global offset table (GOT), at the cost of
217      slightly increased program load times.
219 '--enable-pt_chown'
220      The file 'pt_chown' is a helper binary for 'grantpt' (*note
221      Pseudo-Terminals: Allocation.) that is installed setuid root to fix
222      up pseudo-terminal ownership on GNU/Hurd.  It is not required on
223      GNU/Linux, and the GNU C Library will not use the installed
224      'pt_chown' program when configured with '--enable-pt_chown'.
226 '--disable-werror'
227      By default, the GNU C Library is built with '-Werror'.  If you wish
228      to build without this option (for example, if building with a newer
229      version of GCC than this version of the GNU C Library was tested
230      with, so new warnings cause the build with '-Werror' to fail), you
231      can configure with '--disable-werror'.
233 '--disable-mathvec'
234      By default for x86_64, the GNU C Library is built with the vector
235      math library.  Use this option to disable the vector math library.
237 '--enable-tunables'
238      Tunables support allows additional library parameters to be
239      customized at runtime.  This feature is enabled by default.  This
240      option can take the following values:
242      'yes'
243           This is the default if no option is passed to configure.  This
244           enables tunables and selects the default frontend (currently
245           'valstring').
247      'no'
248           This option disables tunables.
250      'valstring'
251           This enables tunables and selects the 'valstring' frontend for
252           tunables.  This frontend allows users to specify tunables as a
253           colon-separated list in a single environment variable
254           'GLIBC_TUNABLES'.
256 '--disable-crypt'
257      Do not install the passphrase-hashing library 'libcrypt' or the
258      header file 'crypt.h'.  'unistd.h' will still declare the function
259      'crypt'.  Using this option does not change the set of programs
260      that may need to be linked with '-lcrypt'; it only means that the
261      GNU C Library will not provide that library.
263      This option is for hackers and distributions experimenting with
264      independently-maintained implementations of libcrypt.  It may
265      become the default in a future release.
267 '--disable-experimental-malloc'
268      By default, a per-thread cache is enabled in 'malloc'.  While this
269      cache can be disabled on a per-application basis using tunables
270      (set glibc.malloc.tcache_count to zero), this option can be used to
271      remove it from the build completely.
273 '--disable-scv'
274      Disable using 'scv' instruction for syscalls.  All syscalls will
275      use 'sc' instead, even if the kernel supports 'scv'.  PowerPC only.
277 '--build=BUILD-SYSTEM'
278 '--host=HOST-SYSTEM'
279      These options are for cross-compiling.  If you specify both options
280      and BUILD-SYSTEM is different from HOST-SYSTEM, 'configure' will
281      prepare to cross-compile the GNU C Library from BUILD-SYSTEM to be
282      used on HOST-SYSTEM.  You'll probably need the '--with-headers'
283      option too, and you may have to override CONFIGURE's selection of
284      the compiler and/or binutils.
286      If you only specify '--host', 'configure' will prepare for a native
287      compile but use what you specify instead of guessing what your
288      system is.  This is most useful to change the CPU submodel.  For
289      example, if 'configure' guesses your machine as 'i686-pc-linux-gnu'
290      but you want to compile a library for 586es, give
291      '--host=i586-pc-linux-gnu' or just '--host=i586-linux' and add the
292      appropriate compiler flags ('-mcpu=i586' will do the trick) to
293      'CC'.
295      If you specify just '--build', 'configure' will get confused.
297 '--with-pkgversion=VERSION'
298      Specify a description, possibly including a build number or build
299      date, of the binaries being built, to be included in '--version'
300      output from programs installed with the GNU C Library.  For
301      example, '--with-pkgversion='FooBar GNU/Linux glibc build 123''.
302      The default value is 'GNU libc'.
304 '--with-bugurl=URL'
305      Specify the URL that users should visit if they wish to report a
306      bug, to be included in '--help' output from programs installed with
307      the GNU C Library.  The default value refers to the main
308      bug-reporting information for the GNU C Library.
310    To build the library and related programs, type 'make'.  This will
311 produce a lot of output, some of which may look like errors from 'make'
312 but aren't.  Look for error messages from 'make' containing '***'.
313 Those indicate that something is seriously wrong.
315    The compilation process can take a long time, depending on the
316 configuration and the speed of your machine.  Some complex modules may
317 take a very long time to compile, as much as several minutes on slower
318 machines.  Do not panic if the compiler appears to hang.
320    If you want to run a parallel make, simply pass the '-j' option with
321 an appropriate numeric parameter to 'make'.  You need a recent GNU
322 'make' version, though.
324    To build and run test programs which exercise some of the library
325 facilities, type 'make check'.  If it does not complete successfully, do
326 not use the built library, and report a bug after verifying that the
327 problem is not already known.  *Note Reporting Bugs::, for instructions
328 on reporting bugs.  Note that some of the tests assume they are not
329 being run by 'root'.  We recommend you compile and test the GNU C
330 Library as an unprivileged user.
332    Before reporting bugs make sure there is no problem with your system.
333 The tests (and later installation) use some pre-existing files of the
334 system such as '/etc/passwd', '/etc/nsswitch.conf' and others.  These
335 files must all contain correct and sensible content.
337    Normally, 'make check' will run all the tests before reporting all
338 problems found and exiting with error status if any problems occurred.
339 You can specify 'stop-on-test-failure=y' when running 'make check' to
340 make the test run stop and exit with an error status immediately when a
341 failure occurs.
343    To format the 'GNU C Library Reference Manual' for printing, type
344 'make dvi'.  You need a working TeX installation to do this.  The
345 distribution builds the on-line formatted version of the manual, as Info
346 files, as part of the build process.  You can build them manually with
347 'make info'.
349    The library has a number of special-purpose configuration parameters
350 which you can find in 'Makeconfig'.  These can be overwritten with the
351 file 'configparms'.  To change them, create a 'configparms' in your
352 build directory and add values as appropriate for your system.  The file
353 is included and parsed by 'make' and has to follow the conventions for
354 makefiles.
356    It is easy to configure the GNU C Library for cross-compilation by
357 setting a few variables in 'configparms'.  Set 'CC' to the
358 cross-compiler for the target you configured the library for; it is
359 important to use this same 'CC' value when running 'configure', like
360 this: 'configure TARGET CC=TARGET-gcc'.  Set 'BUILD_CC' to the compiler
361 to use for programs run on the build system as part of compiling the
362 library.  You may need to set 'AR' to cross-compiling versions of 'ar'
363 if the native tools are not configured to work with object files for the
364 target you configured for.  When cross-compiling the GNU C Library, it
365 may be tested using 'make check
366 test-wrapper="SRCDIR/scripts/cross-test-ssh.sh HOSTNAME"', where SRCDIR
367 is the absolute directory name for the main source directory and
368 HOSTNAME is the host name of a system that can run the newly built
369 binaries of the GNU C Library.  The source and build directories must be
370 visible at the same locations on both the build system and HOSTNAME.
371 The 'cross-test-ssh.sh' script requires 'flock' from 'util-linux' to
372 work when GLIBC_TEST_ALLOW_TIME_SETTING environment variable is set.
374    It is also possible to execute tests, which require setting the date
375 on the target machine.  Following use cases are supported:
376    * 'GLIBC_TEST_ALLOW_TIME_SETTING' is set in the environment in which
377      eligible tests are executed and have the privilege to run
378      'clock_settime'.  In this case, nothing prevents those tests from
379      running in parallel, so the caller shall assure that those tests
380      are serialized or provide a proper wrapper script for them.
382    * The 'cross-test-ssh.sh' script is used and one passes the
383      '--allow-time-setting' flag.  In this case, both sets
384      'GLIBC_TEST_ALLOW_TIME_SETTING' and serialization of test execution
385      are assured automatically.
387    In general, when testing the GNU C Library, 'test-wrapper' may be set
388 to the name and arguments of any program to run newly built binaries.
389 This program must preserve the arguments to the binary being run, its
390 working directory and the standard input, output and error file
391 descriptors.  If 'TEST-WRAPPER env' will not work to run a program with
392 environment variables set, then 'test-wrapper-env' must be set to a
393 program that runs a newly built program with environment variable
394 assignments in effect, those assignments being specified as 'VAR=VALUE'
395 before the name of the program to be run.  If multiple assignments to
396 the same variable are specified, the last assignment specified must take
397 precedence.  Similarly, if 'TEST-WRAPPER env -i' will not work to run a
398 program with an environment completely empty of variables except those
399 directly assigned, then 'test-wrapper-env-only' must be set; its use has
400 the same syntax as 'test-wrapper-env', the only difference in its
401 semantics being starting with an empty set of environment variables
402 rather than the ambient set.
404    For AArch64 with SVE, when testing the GNU C Library, 'test-wrapper'
405 may be set to "SRCDIR/sysdeps/unix/sysv/linux/aarch64/vltest.py
406 VECTOR-LENGTH" to change Vector Length.
408 Installing the C Library
409 ========================
411 To install the library and its header files, and the Info files of the
412 manual, type 'make install'.  This will build things, if necessary,
413 before installing them; however, you should still compile everything
414 first.  If you are installing the GNU C Library as your primary C
415 library, we recommend that you shut the system down to single-user mode
416 first, and reboot afterward.  This minimizes the risk of breaking things
417 when the library changes out from underneath.
419    'make install' will do the entire job of upgrading from a previous
420 installation of the GNU C Library version 2.x.  There may sometimes be
421 headers left behind from the previous installation, but those are
422 generally harmless.  If you want to avoid leaving headers behind you can
423 do things in the following order.
425    You must first build the library ('make'), optionally check it ('make
426 check'), switch the include directories and then install ('make
427 install').  The steps must be done in this order.  Not moving the
428 directory before install will result in an unusable mixture of header
429 files from both libraries, but configuring, building, and checking the
430 library requires the ability to compile and run programs against the old
431 library.  The new '/usr/include', after switching the include
432 directories and before installing the library should contain the Linux
433 headers, but nothing else.  If you do this, you will need to restore any
434 headers from libraries other than the GNU C Library yourself after
435 installing the library.
437    You can install the GNU C Library somewhere other than where you
438 configured it to go by setting the 'DESTDIR' GNU standard make variable
439 on the command line for 'make install'.  The value of this variable is
440 prepended to all the paths for installation.  This is useful when
441 setting up a chroot environment or preparing a binary distribution.  The
442 directory should be specified with an absolute file name.  Installing
443 with the 'prefix' and 'exec_prefix' GNU standard make variables set is
444 not supported.
446    The GNU C Library includes a daemon called 'nscd', which you may or
447 may not want to run.  'nscd' caches name service lookups; it can
448 dramatically improve performance with NIS+, and may help with DNS as
449 well.
451    One auxiliary program, '/usr/libexec/pt_chown', is installed setuid
452 'root' if the '--enable-pt_chown' configuration option is used.  This
453 program is invoked by the 'grantpt' function; it sets the permissions on
454 a pseudoterminal so it can be used by the calling process.  If you are
455 using a Linux kernel with the 'devpts' filesystem enabled and mounted at
456 '/dev/pts', you don't need this program.
458    After installation you should configure the timezone and install
459 locales for your system.  The time zone configuration ensures that your
460 system time matches the time for your current timezone.  The locales
461 ensure that the display of information on your system matches the
462 expectations of your language and geographic region.
464    The GNU C Library is able to use two kinds of localization
465 information sources, the first is a locale database named
466 'locale-archive' which is generally installed as
467 '/usr/lib/locale/locale-archive'.  The locale archive has the benefit of
468 taking up less space and being very fast to load, but only if you plan
469 to install sixty or more locales.  If you plan to install one or two
470 locales you can instead install individual locales into their self-named
471 directories e.g. '/usr/lib/locale/en_US.utf8'.  For example to install
472 the German locale using the character set for UTF-8 with name 'de_DE'
473 into the locale archive issue the command 'localedef -i de_DE -f UTF-8
474 de_DE', and to install just the one locale issue the command 'localedef
475 --no-archive -i de_DE -f UTF-8 de_DE'.  To configure all locales that
476 are supported by the GNU C Library, you can issue from your build
477 directory the command 'make localedata/install-locales' to install all
478 locales into the locale archive or 'make
479 localedata/install-locale-files' to install all locales as files in the
480 default configured locale installation directory (derived from
481 '--prefix' or '--localedir').  To install into an alternative system
482 root use 'DESTDIR' e.g. 'make localedata/install-locale-files
483 DESTDIR=/opt/glibc', but note that this does not change the configured
484 prefix.
486    To configure the locally used timezone, set the 'TZ' environment
487 variable.  The script 'tzselect' helps you to select the right value.
488 As an example, for Germany, 'tzselect' would tell you to use
489 'TZ='Europe/Berlin''.  For a system wide installation (the given paths
490 are for an installation with '--prefix=/usr'), link the timezone file
491 which is in '/usr/share/zoneinfo' to the file '/etc/localtime'.  For
492 Germany, you might execute 'ln -s /usr/share/zoneinfo/Europe/Berlin
493 /etc/localtime'.
495 Recommended Tools for Compilation
496 =================================
498 We recommend installing the following GNU tools before attempting to
499 build the GNU C Library:
501    * GNU 'make' 4.0 or newer
503      As of relase time, GNU 'make' 4.4 is the newest verified to work to
504      build the GNU C Library.
506    * GCC 6.2 or newer
508      GCC 6.2 or higher is required.  In general it is recommended to use
509      the newest version of the compiler that is known to work for
510      building the GNU C Library, as newer compilers usually produce
511      better code.  As of release time, GCC 13.0 is the newest compiler
512      verified to work to build the GNU C Library.
514      For PowerPC 64-bits little-endian (powerpc64le), a GCC version with
515      support for '-mno-gnu-attribute', '-mabi=ieeelongdouble', and
516      '-mabi=ibmlondouble' is required.  Likewise, the compiler must also
517      support passing '-mlong-double-128' with the preceding options.  As
518      of release, this implies GCC 7.4 and newer (excepting GCC 7.5.0,
519      see GCC PR94200).  These additional features are required for
520      building the GNU C Library with support for IEEE long double.
522      For ARC architecture builds, GCC 8.3 or higher is needed.
524      For s390x architecture builds, GCC 7.1 or higher is needed (See gcc
525      Bug 98269).
527      For multi-arch support it is recommended to use a GCC which has
528      been built with support for GNU indirect functions.  This ensures
529      that correct debugging information is generated for functions
530      selected by IFUNC resolvers.  This support can either be enabled by
531      configuring GCC with '--enable-gnu-indirect-function', or by
532      enabling it by default by setting 'default_gnu_indirect_function'
533      variable for a particular architecture in the GCC source file
534      'gcc/config.gcc'.
536      You can use whatever compiler you like to compile programs that use
537      the GNU C Library.
539      Check the FAQ for any special compiler issues on particular
540      platforms.
542    * GNU 'binutils' 2.25 or later
544      You must use GNU 'binutils' (as and ld) to build the GNU C Library.
545      No other assembler or linker has the necessary functionality at the
546      moment.  As of release time, GNU 'binutils' 2.39 is the newest
547      verified to work to build the GNU C Library.
549      For PowerPC 64-bits little-endian (powerpc64le), 'objcopy' is
550      required to support '--update-section'.  This option requires
551      binutils 2.26 or newer.
553      ARC architecture needs 'binutils' 2.32 or higher for TLS related
554      fixes.
556    * GNU 'texinfo' 4.7 or later
558      To correctly translate and install the Texinfo documentation you
559      need this version of the 'texinfo' package.  Earlier versions do
560      not understand all the tags used in the document, and the
561      installation mechanism for the info files is not present or works
562      differently.  As of release time, 'texinfo' 7.0.2 is the newest
563      verified to work to build the GNU C Library.
565    * GNU 'awk' 3.1.2, or higher
567      'awk' is used in several places to generate files.  Some 'gawk'
568      extensions are used, including the 'asorti' function, which was
569      introduced in version 3.1.2 of 'gawk'.  As of release time, 'gawk'
570      version 5.1.1 is the newest verified to work to build the GNU C
571      Library.
573    * GNU 'bison' 2.7 or later
575      'bison' is used to generate the 'yacc' parser code in the 'intl'
576      subdirectory.  As of release time, 'bison' version 3.8.2 is the
577      newest verified to work to build the GNU C Library.
579    * Perl 5
581      Perl is not required, but if present it is used in some tests and
582      the 'mtrace' program, to build the GNU C Library manual.  As of
583      release time 'perl' version 5.36.0 is the newest verified to work
584      to build the GNU C Library.
586    * GNU 'sed' 3.02 or newer
588      'Sed' is used in several places to generate files.  Most scripts
589      work with any version of 'sed'.  As of release time, 'sed' version
590      4.8 is the newest verified to work to build the GNU C Library.
592    * Python 3.4 or later
594      Python is required to build the GNU C Library.  As of release time,
595      Python 3.11 is the newest verified to work for building and testing
596      the GNU C Library.
598    * PExpect 4.0
600      The pretty printer tests drive GDB through test programs and
601      compare its output to the printers'.  PExpect is used to capture
602      the output of GDB, and should be compatible with the Python version
603      in your system.  As of release time PExpect 4.8.0 is the newest
604      verified to work to test the pretty printers.
606    * GDB 7.8 or later with support for Python 2.7/3.4 or later
608      GDB itself needs to be configured with Python support in order to
609      use the pretty printers.  Notice that your system having Python
610      available doesn't imply that GDB supports it, nor that your
611      system's Python and GDB's have the same version.  As of release
612      time GNU 'debugger' 12.1 is the newest verified to work to test the
613      pretty printers.
615      Unless Python, PExpect and GDB with Python support are present, the
616      printer tests will report themselves as 'UNSUPPORTED'.  Notice that
617      some of the printer tests require the GNU C Library to be compiled
618      with debugging symbols.
620 If you change any of the 'configure.ac' files you will also need
622    * GNU 'autoconf' 2.69 (exactly)
624 and if you change any of the message translation files you will need
626    * GNU 'gettext' 0.10.36 or later
628      As of release time, GNU 'gettext' version 0.21.1 is the newest
629      version verified to work to build the GNU C Library.
631 You may also need these packages if you upgrade your source tree using
632 patches, although we try to avoid this.
634 Specific advice for GNU/Linux systems
635 =====================================
637 If you are installing the GNU C Library on GNU/Linux systems, you need
638 to have the header files from a 3.2 or newer kernel around for
639 reference.  (For the ia64 architecture, you need version 3.2.18 or newer
640 because this is the first version with support for the 'accept4' system
641 call.)  These headers must be installed using 'make headers_install';
642 the headers present in the kernel source directory are not suitable for
643 direct use by the GNU C Library.  You do not need to use that kernel,
644 just have its headers installed where the GNU C Library can access them,
645 referred to here as INSTALL-DIRECTORY.  The easiest way to do this is to
646 unpack it in a directory such as '/usr/src/linux-VERSION'.  In that
647 directory, run 'make headers_install
648 INSTALL_HDR_PATH=INSTALL-DIRECTORY'.  Finally, configure the GNU C
649 Library with the option '--with-headers=INSTALL-DIRECTORY/include'.  Use
650 the most recent kernel you can get your hands on.  (If you are
651 cross-compiling the GNU C Library, you need to specify
652 'ARCH=ARCHITECTURE' in the 'make headers_install' command, where
653 ARCHITECTURE is the architecture name used by the Linux kernel, such as
654 'x86' or 'powerpc'.)
656    After installing the GNU C Library, you may need to remove or rename
657 directories such as '/usr/include/linux' and '/usr/include/asm', and
658 replace them with copies of directories such as 'linux' and 'asm' from
659 'INSTALL-DIRECTORY/include'.  All directories present in
660 'INSTALL-DIRECTORY/include' should be copied, except that the GNU C
661 Library provides its own version of '/usr/include/scsi'; the files
662 provided by the kernel should be copied without replacing those provided
663 by the GNU C Library.  The 'linux', 'asm' and 'asm-generic' directories
664 are required to compile programs using the GNU C Library; the other
665 directories describe interfaces to the kernel but are not required if
666 not compiling programs using those interfaces.  You do not need to copy
667 kernel headers if you did not specify an alternate kernel header source
668 using '--with-headers'.
670    The Filesystem Hierarchy Standard for GNU/Linux systems expects some
671 components of the GNU C Library installation to be in '/lib' and some in
672 '/usr/lib'.  This is handled automatically if you configure the GNU C
673 Library with '--prefix=/usr'.  If you set some other prefix or allow it
674 to default to '/usr/local', then all the components are installed there.
676    As of release time, Linux version 6.1.5 is the newest stable version
677 verified to work to build the GNU C Library.
679 Reporting Bugs
680 ==============
682 There are probably bugs in the GNU C Library.  There are certainly
683 errors and omissions in this manual.  If you report them, they will get
684 fixed.  If you don't, no one will ever know about them and they will
685 remain unfixed for all eternity, if not longer.
687    It is a good idea to verify that the problem has not already been
688 reported.  Bugs are documented in two places: The file 'BUGS' describes
689 a number of well known bugs and the central GNU C Library bug tracking
690 system has a WWW interface at <https://sourceware.org/bugzilla/>.  The
691 WWW interface gives you access to open and closed reports.  A closed
692 report normally includes a patch or a hint on solving the problem.
694    To report a bug, first you must find it.  With any luck, this will be
695 the hard part.  Once you've found a bug, make sure it's really a bug.  A
696 good way to do this is to see if the GNU C Library behaves the same way
697 some other C library does.  If so, probably you are wrong and the
698 libraries are right (but not necessarily).  If not, one of the libraries
699 is probably wrong.  It might not be the GNU C Library.  Many historical
700 Unix C libraries permit things that we don't, such as closing a file
701 twice.
703    If you think you have found some way in which the GNU C Library does
704 not conform to the ISO and POSIX standards (*note Standards and
705 Portability::), that is definitely a bug.  Report it!
707    Once you're sure you've found a bug, try to narrow it down to the
708 smallest test case that reproduces the problem.  In the case of a C
709 library, you really only need to narrow it down to one library function
710 call, if possible.  This should not be too difficult.
712    The final step when you have a simple test case is to report the bug.
713 Do this at <https://www.gnu.org/software/libc/bugs.html>.
715    If you are not sure how a function should behave, and this manual
716 doesn't tell you, that's a bug in the manual.  Report that too!  If the
717 function's behavior disagrees with the manual, then either the library
718 or the manual has a bug, so report the disagreement.  If you find any
719 errors or omissions in this manual, please report them to the bug
720 database.  If you refer to specific sections of the manual, please
721 include the section names for easier identification.