Mark mtrace tests UNSUPPORTED if bug-ga2.mtrace or tst-leaks2.mtrace are missing
[glibc.git] / README
blobd0f0edb3930a76ff1d1cac8026a23b125406d2d2
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[4567]86-*-gnu.
17 When working with Linux kernels, this version of the GNU C Library
18 requires Linux kernel version 3.2 or later.
20 Also note that the shared version of the libgcc_s library must be
21 installed for the pthread library to work correctly.
23 The GNU C Library supports these configurations for using Linux kernels:
25         aarch64*-*-linux-gnu
26         alpha*-*-linux-gnu
27         arc*-*-linux-gnu
28         arm-*-linux-gnueabi
29         csky-*-linux-gnuabiv2
30         hppa-*-linux-gnu
31         i[4567]86-*-linux-gnu
32         x86_64-*-linux-gnu      Can build either x86_64 or x32
33         ia64-*-linux-gnu
34         m68k-*-linux-gnu
35         microblaze*-*-linux-gnu
36         mips-*-linux-gnu
37         mips64-*-linux-gnu
38         powerpc-*-linux-gnu     Hardware or software floating point, BE only.
39         powerpc64*-*-linux-gnu  Big-endian and little-endian.
40         s390-*-linux-gnu
41         s390x-*-linux-gnu
42         riscv32-*-linux-gnu
43         riscv64-*-linux-gnu
44         sh[34]-*-linux-gnu
45         sparc*-*-linux-gnu
46         sparc64*-*-linux-gnu
48 If you are interested in doing a port, please contact the glibc
49 maintainers; see https://www.gnu.org/software/libc/ for more
50 information.
52 See the file INSTALL to find out how to configure, build, and install
53 the GNU C Library.  You might also consider reading the WWW pages for
54 the C library at https://www.gnu.org/software/libc/.
56 The GNU C Library is (almost) completely documented by the Texinfo manual
57 found in the `manual/' subdirectory.  The manual is still being updated
58 and contains some known errors and omissions; we regret that we do not
59 have the resources to work on the manual as much as we would like.  For
60 corrections to the manual, please file a bug in the `manual' component,
61 following the bug-reporting instructions below.  Please be sure to check
62 the manual in the current development sources to see if your problem has
63 already been corrected.
65 Please see https://www.gnu.org/software/libc/bugs.html for bug reporting
66 information.  We are now using the Bugzilla system to track all bug reports.
67 This web page gives detailed information on how to report bugs properly.
69 The GNU C Library is free software.  See the file COPYING.LIB for copying
70 conditions, and LICENSES for notices about a few contributions that require
71 these additional notices to be distributed.  License copyright years may be
72 listed using range notation, e.g., 1996-2015, indicating that every year in
73 the range, inclusive, is a copyrightable year that would otherwise be listed
74 individually.