2006-02-28 Roland McGrath <roland@redhat.com>
[glibc-ports.git] / README
blobf395a05c356cad34705fca9dcdb758ee39775428
1 This is the glibc ports repository, an add-on for the GNU C Library (glibc).
2 It contains code that is not maintained in the official glibc source tree.
4 This includes working ports to GNU/Linux on some machine architectures that
5 are not maintained in the official glibc source tree.  It also includes
6 some code once used by old libc ports now defunct, which has been abandoned
7 but may be useful for some future porter to examine.  It may also include
8 some optimized functions tailored for specific CPU implementations of an
9 architecture, to be selected using --with-cpu.
11 The ports repository is cooperatively maintained by volunteers on the
12 <libc-ports@sourceware.org> mailing list, and housed in the glibc CVS as a
13 module called "ports".  See http://www.gnu.org/software/libc/resources.html
14 for details on using CVS.  To report a bug in code housed in the ports
15 repository, please go to http://sources.redhat.com/bugzilla/ and file a bug
16 report under the glibc "ports" component.
18 An add-on for an individual port can be made from just the sysdeps/
19 subdirectories containing the port's code.  You may want to include a
20 README and Banner of your own talking about your port's code in particular,
21 rather than the generic ones here.
23 The real source code for any ports is found in the sysdeps/ subdirectories.
24 These should be exactly what would go into the main libc source tree if you
25 were to incorporate it directly.  The only exceptions are the files
26 sysdeps/*/preconfigure and sysdeps/*/preconfigure.in; these are fragments
27 used by this add-on's configure fragment.  The purpose of these is to set
28 $base_machine et al when the main libc configure's defaults are not right
29 for some machine.  Everything else can and should be done from a normal
30 sysdeps/.../configure fragment that is used only when the configuration
31 selects that sysdeps subdirectory.  Each port that requires some special
32 treatment before the sysdeps directory list is calculated, should add a
33 sysdeps/CPU/preconfigure file; this can either be written by hand or
34 generated by Autoconf from sysdeps/CPU/preconfigure.in, and follow the
35 rules for glibc add-on configure fragments.  No preconfigure file should do
36 anything on an unrelated configuration, so that disparate ports can be put
37 into a single add-on without interfering with each other.
39 Like all glibc add-ons, this must be used by specifying the directory in
40 the --enable-add-ons option when running glibc's configure script.
43 $Id$