string: Improve generic strchr
[glibc.git] / README
blob63f3a1bebf3f6754d66ed8de76e0274160e0009c
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         loongarch64-*-linux-gnu Hardware floating point, LE only.
35         m68k-*-linux-gnu
36         microblaze*-*-linux-gnu
37         mips-*-linux-gnu
38         mips64-*-linux-gnu
39         or1k-*-linux-gnu
40         powerpc-*-linux-gnu     Hardware or software floating point, BE only.
41         powerpc64*-*-linux-gnu  Big-endian and little-endian.
42         s390-*-linux-gnu
43         s390x-*-linux-gnu
44         riscv32-*-linux-gnu
45         riscv64-*-linux-gnu
46         sh[34]-*-linux-gnu
47         sparc*-*-linux-gnu
48         sparc64*-*-linux-gnu
50 If you are interested in doing a port, please contact the glibc
51 maintainers; see https://www.gnu.org/software/libc/ for more
52 information.
54 See the file INSTALL to find out how to configure, build, and install
55 the GNU C Library.  You might also consider reading the WWW pages for
56 the C library at https://www.gnu.org/software/libc/.
58 The GNU C Library is (almost) completely documented by the Texinfo manual
59 found in the `manual/' subdirectory.  The manual is still being updated
60 and contains some known errors and omissions; we regret that we do not
61 have the resources to work on the manual as much as we would like.  For
62 corrections to the manual, please file a bug in the `manual' component,
63 following the bug-reporting instructions below.  Please be sure to check
64 the manual in the current development sources to see if your problem has
65 already been corrected.
67 Please see https://www.gnu.org/software/libc/bugs.html for bug reporting
68 information.  We are now using the Bugzilla system to track all bug reports.
69 This web page gives detailed information on how to report bugs properly.
71 The GNU C Library is free software.  See the file COPYING.LIB for copying
72 conditions, and LICENSES for notices about a few contributions that require
73 these additional notices to be distributed.  License copyright years may be
74 listed using range notation, e.g., 1996-2015, indicating that every year in
75 the range, inclusive, is a copyrightable year that would otherwise be listed
76 individually.