* manual/llio.texi: Document MTASC-safety properties.
[jlayton/glibc.git] / README
1 This directory contains the sources of the GNU C Library.
2 See the file "version.h" for what release version you have.
3
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.
9
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.
13
14 The GNU C Library implements much of the POSIX.1 functionality in the
15 GNU/Hurd system, using configurations i[4567]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.
18
19 When working with Linux kernels, this version of the GNU C Library
20 requires Linux kernel version 2.6.16 or later.
21
22 Also note that the shared version of the libgcc_s library must be
23 installed for the pthread library to work correctly.
24
25 The GNU C Library supports these configurations for using Linux kernels:
26
27         i[4567]86-*-linux-gnu
28         x86_64-*-linux-gnu      Can build either x86_64 or x32
29         powerpc-*-linux-gnu     Hardware or software floating point, BE only.
30         powerpc64*-*-linux-gnu  Big-endian and little-endian.
31         s390-*-linux-gnu
32         s390x-*-linux-gnu
33         sh[34]-*-linux-gnu
34         sparc*-*-linux-gnu
35         sparc64*-*-linux-gnu
36
37 The code for other CPU configurations supported by volunteers outside of
38 the core glibc maintenance effort is contained in the `ports' add-on,
39 located in the `ports' subdirectory of the source tree.
40
41         aarch64*-*-linux-gnu
42         alpha*-*-linux-gnu
43         am33*-*-linux-gnu       Not currently functional
44         arm-*-linux-gnueabi
45         hppa-*-linux-gnu        Not currently functional without patches.
46         ia64-*-linux-gnu
47         m68k-*-linux-gnu
48         mips-*-linux-gnu
49         mips64-*-linux-gnu
50         tilegx-*-linux-gnu
51         tilepro-*-linux-gnu
52
53 If you are interested in doing a port, please contact the glibc
54 maintainers; see http://www.gnu.org/software/libc/ for more
55 information.
56
57 See the file INSTALL to find out how to configure, build, and install
58 the GNU C Library.  You might also consider reading the WWW pages for
59 the C library at http://www.gnu.org/software/libc/.
60
61 The GNU C Library is (almost) completely documented by the Texinfo manual
62 found in the `manual/' subdirectory.  The manual is still being updated
63 and contains some known errors and omissions; we regret that we do not
64 have the resources to work on the manual as much as we would like.  For
65 corrections to the manual, please file a bug in the `manual' component,
66 following the bug-reporting instructions below.  Please be sure to check
67 the manual in the current development sources to see if your problem has
68 already been corrected.
69
70 Please see http://www.gnu.org/software/libc/bugs.html for bug reporting
71 information.  We are now using the Bugzilla system to track all bug reports.
72 This web page gives detailed information on how to report bugs properly.
73
74 The GNU C Library is free software.  See the file COPYING.LIB for copying
75 conditions, and LICENSES for notices about a few contributions that require
76 these additional notices to be distributed.  License copyright years may be
77 listed using range notation, e.g., 2000-2013, indicating that every year in
78 the range, inclusive, is a copyrightable year that would otherwise be listed
79 individually.