Clarify memory allocation error diagnostics to avoid confusion
[glibc.git] / README
blob1d90b55208a031c8d03f986f046f225bda3231ea
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, this version of the GNU C Library
20 requires Linux kernel version 2.6.16 or later.
22 Also note that the shared version of the libgcc_s library must be
23 installed for the pthread library to work correctly.
25 The GNU C Library supports these configurations for using Linux kernels:
27         i[4567]86-*-linux-gnu
28         x86_64-*-linux-gnu      Can build either x86_64 or x32
29         powerpc-*-linux-gnu     Hardware floating point required
30         powerpc64-*-linux-gnu
31         s390-*-linux-gnu
32         s390x-*-linux-gnu
33         sh[34]-*-linux-gnu
34         sparc*-*-linux-gnu
35         sparc64*-*-linux-gnu
37 The code for other CPU configurations supported by volunteers outside of
38 the core glibc maintenance effort is contained in the separate `ports'
39 add-on.  You can find glibc-ports-VERSION distributed separately in the
40 same place where you got the main glibc distribution files.
41 Currently these configurations have code in the `ports' add-on:
43         alpha*-*-linux-gnu
44         am33*-*-linux-gnu       Not currently functional
45         arm-*-linux-gnueabi
46         hppa-*-linux-gnu        Not currently functional without patches.
47         ia64-*-linux-gnu
48         m68k-*-linux-gnu
49         mips-*-linux-gnu
50         mips64-*-linux-gnu
51         powerpc-*-linux-gnu     Software floating point (--without-fp)
52         tilegx-*-linux-gnu
53         tilepro-*-linux-gnu
55 If you are interested in doing a port, please contact the glibc
56 maintainers; see http://www.gnu.org/software/libc/ for more
57 information.
59 See the file INSTALL to find out how to configure, build, and install
60 the GNU C Library.  You might also consider reading the WWW pages for
61 the C library at http://www.gnu.org/software/libc/.
63 The GNU C Library is (almost) completely documented by the Texinfo manual
64 found in the `manual/' subdirectory.  The manual is still being updated
65 and contains some known errors and omissions; we regret that we do not
66 have the resources to work on the manual as much as we would like.  For
67 corrections to the manual, please file a bug in the `manual' component,
68 following the bug-reporting instructions below.  Please be sure to check
69 the manual in the current development sources to see if your problem has
70 already been corrected.
72 Please see http://www.gnu.org/software/libc/bugs.html for bug reporting
73 information.  We are now using the Bugzilla system to track all bug reports.
74 This web page gives detailed information on how to report bugs properly.
76 The GNU C Library is free software.  See the file COPYING.LIB for copying
77 conditions, and LICENSES for notices about a few contributions that require
78 these additional notices to be distributed.  License copyright years may be
79 listed using range notation, e.g., 2000-2011, indicating that every year in
80 the range, inclusive, is a copyrightable year that would otherwise be listed
81 individually.