Update NEWS
[glibc.git] / README
blob1e2e3ba18a0e8a159c565e7aa4edae2835bcac5d
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.  The current
16 GNU/Hurd support requires out-of-tree patches that will eventually be
17 incorporated into an official GNU C Library release.
19 When working with Linux kernels, the GNU C Library version from
20 version 2.4 on is intended primarily for use with Linux kernel version
21 2.6.0 and later.  We only support using the NPTL implementation of
22 pthreads, which is now the default configuration.  The library is
23 unlikely to build without NPTL, or to work on Linux kernels prior to
24 2.6.  The old LinuxThreads add-on implementation of pthreads for older
25 Linux kernels is no longer supported, and we are not distributing it
26 with this release.
28 All Linux kernel versions prior to 2.6.16 are known to have some bugs that
29 may cause some of the tests related to pthreads in "make check" to fail.
30 If you see such problems, please try the test suite on the most recent
31 Linux kernel version that you can use, before pursuing those bugs further.
33 Also note that the shared version of the libgcc_s library must be
34 installed for the pthread library to work correctly.
36 The GNU C Library supports these configurations for using Linux kernels:
38         i[4567]86-*-linux-gnu
39         x86_64-*-linux-gnu      Can build either x86_64 or x32
40         powerpc-*-linux-gnu     Hardware floating point required
41         powerpc64-*-linux-gnu
42         s390-*-linux-gnu
43         s390x-*-linux-gnu
44         sh[34]-*-linux-gnu      Requires Linux 2.6.11 or newer
45         sparc*-*-linux-gnu
46         sparc64*-*-linux-gnu
48 The code for other CPU configurations supported by volunteers outside of
49 the core glibc maintenance effort is contained in the separate `ports'
50 add-on.  You can find glibc-ports-VERSION distributed separately in the
51 same place where you got the main glibc distribution files.
52 Currently these configurations have code in the `ports' add-on:
54         alpha*-*-linux-gnu      Requires Linux 2.6.9 or newer for NPTL
55         am33*-*-linux-gnu       Not currently functional
56         arm-*-linux-gnueabi     Requires Linux 2.6.16-rc1 or newer for NPTL
57         hppa-*-linux-gnu        Not currently functional without patches.
58         ia64-*-linux-gnu
59         m68k-*-linux-gnu
60         mips-*-linux-gnu        Requires Linux 2.6.12 or newer for NPTL
61         mips64-*-linux-gnu      Requires Linux 2.6.12 or newer for NPTL
62         powerpc-*-linux-gnu     Software floating point (--without-fp)
63         tilegx-*-linux-gnu
64         tilepro-*-linux-gnu
66 If you are interested in doing a port, please contact the glibc
67 maintainers; see http://www.gnu.org/software/libc/ for more
68 information.
70 See the file INSTALL to find out how to configure, build, and install
71 the GNU C Library.  You might also consider reading the WWW pages for
72 the C library at http://www.gnu.org/software/libc/.
74 The GNU C Library is (almost) completely documented by the Texinfo manual
75 found in the `manual/' subdirectory.  The manual is still being updated
76 and contains some known errors and omissions; we regret that we do not
77 have the resources to work on the manual as much as we would like.  For
78 corrections to the manual, please file a bug in the `manual' component,
79 following the bug-reporting instructions below.  Please be sure to check
80 the manual in the current development sources to see if your problem has
81 already been corrected.
83 Please see http://www.gnu.org/software/libc/bugs.html for bug reporting
84 information.  We are now using the Bugzilla system to track all bug reports.
85 This web page gives detailed information on how to report bugs properly.
87 The GNU C Library is free software.  See the file COPYING.LIB for copying
88 conditions, and LICENSES for notices about a few contributions that require
89 these additional notices to be distributed.  License copyright years may be
90 listed using range notation, e.g., 2000-2011, indicating that every year in
91 the range, inclusive, is a copyrightable year that would otherwise be listed
92 individually.