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