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