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