Fix make clean for recent elf/Makefile changes.
[glibc.git] / README
bloba479b550f4aa2537b774195735aefbe448eb4329
1 This directory contains the sources of the GNU C Library.
2 See the file "version.h" for what release version you have.
4 The GNU C Library is the standard system C library for all GNU systems,
5 and is an important part of what makes up a GNU system.  It provides the
6 system API for all programs written in C and C-compatible languages such
7 as C++ and Objective C; the runtime facilities of other programming
8 languages use the C library to access the underlying operating system.
10 In GNU/Linux systems, the C library works with the Linux kernel to
11 implement the operating system behavior seen by user applications.
12 In GNU/Hurd systems, it works with a microkernel and Hurd servers.
14 The GNU C Library implements much of the POSIX.1 functionality in the
15 GNU/Hurd system, using configurations i[34567]86-*-gnu.
17 When working with Linux kernels, the GNU C Library version from
18 version 2.4 on is intended primarily for use with Linux kernel version
19 2.6.0 and later.  We only support using the NPTL implementation of
20 pthreads, which is now the default configuration.  The library is
21 unlikely to build without NPTL, or to work on Linux kernels prior to
22 2.6.  The old LinuxThreads add-on implementation of pthreads for older
23 Linux kernels is no longer supported, and we are not distributing it
24 with this release.
26 All Linux kernel versions prior to 2.6.16 are known to have some bugs that
27 may cause some of the tests related to pthreads in "make check" to fail.
28 If you see such problems, please try the test suite on the most recent
29 Linux kernel version that you can use, before pursuing those bugs further.
31 Also note that the shared version of the libgcc_s library must be
32 installed for the pthread library to work correctly.
34 The GNU C Library supports these configurations for using Linux kernels:
36         i[4567]86-*-linux-gnu
37         x86_64-*-linux-gnu
38         powerpc-*-linux-gnu     Hardware floating point required
39         powerpc64-*-linux-gnu
40         s390-*-linux-gnu
41         s390x-*-linux-gnu
42         sh[34]-*-linux-gnu      Requires Linux 2.6.11 or newer
43         sparc*-*-linux-gnu
44         sparc64*-*-linux-gnu
46 The code for other CPU configurations supported by volunteers outside of
47 the core glibc maintenance effort is contained in the separate `ports'
48 add-on.  You can find glibc-ports-VERSION distributed separately in the
49 same place where you got the main glibc distribution files.
50 Currently these configurations have code in the `ports' add-on:
52         alpha*-*-linux-gnu      Requires Linux 2.6.9 or newer for NPTL
53         am33*-*-linux-gnu       Not currently functional
54         arm-*-linux-gnueabi     Requires Linux 2.6.16-rc1 or newer for NPTL
55         hppa-*-linux-gnu        Requires Linux 2.6.9 or newer for NPTL
56         ia64-*-linux-gnu
57         m68k-*-linux-gnu
58         mips-*-linux-gnu        Requires Linux 2.6.12 or newer for NPTL
59         mips64-*-linux-gnu      Requires Linux 2.6.12 or newer for NPTL
60         powerpc-*-linux-gnu     Software floating point (--without-fp)
61         tilegx-*-linux-gnu
62         tilepro-*-linux-gnu
64 If you are interested in doing a port, please contact the glibc
65 maintainers; see http://www.gnu.org/software/libc/ for more
66 information.
68 See the file INSTALL to find out how to configure, build, and install
69 the GNU C Library.  You might also consider reading the WWW pages for
70 the C library at http://www.gnu.org/software/libc/.
72 The GNU C Library is (almost) completely documented by the Texinfo manual
73 found in the `manual/' subdirectory.  The manual is still being updated
74 and contains some known errors and omissions; we regret that we do not
75 have the resources to work on the manual as much as we would like.  For
76 corrections to the manual, please file a bug in the `manual' component,
77 following the bug-reporting instructions below.  Please be sure to check
78 the manual in the current development sources to see if your problem has
79 already been corrected.
81 Please see http://www.gnu.org/software/libc/bugs.html for bug reporting
82 information.  We are now using the Bugzilla system to track all bug reports.
83 This web page gives detailed information on how to report bugs properly.
85 The GNU C Library is free software.  See the file COPYING.LIB for copying
86 conditions, and LICENSES for notices about a few contributions that require
87 these additional notices to be distributed.  License copyright years may be
88 listed using range notation, e.g., 2000-2011, indicating that every year in
89 the range, inclusive, is a copyrightable year that would otherwise be listed
90 individually.