(i[34]86sol2): New abbrev for i[34]86-unknown-solaris2.
[kopensolaris-gnu/glibc.git] / manual / maint.texi
1 @c \input /gd/gnu/doc/texinfo
2 @c This is for making the `INSTALL' file for the distribution.
3 @c Makeinfo ignores it when processing the file from the include.
4 @setfilename INSTALL
5
6 @node Maintenance, Copying, Library Summary, Top
7 @appendix Library Maintenance
8
9 @menu
10 * Installation::          How to configure, compile and
11                              install the GNU C library.
12 * Reporting Bugs::        How to report bugs (if you want to
13                              get them fixed) and other troubles
14                              you may have with the GNU C library.
15 * Source Layout::         How to add new functions or header files
16                              to the GNU C library.
17 * Porting::               How to port the GNU C library to
18                              a new machine or operating system.
19 * Contributors::          Contributors to the GNU C Library.
20 @end menu
21
22 @node Installation
23 @appendixsec How to Install the GNU C Library
24 @cindex installing the library
25
26 Installation of the GNU C library is relatively simple.
27
28 You need the latest version of GNU @code{make}.  Modifying the GNU C
29 Library to work with other @code{make} programs would be so hard that we
30 recommend you port GNU @code{make} instead.  @strong{Really.}@refill
31
32 To configure the GNU C library for your system, run the shell script
33 @file{configure} with @code{sh}.  Use an argument which is the
34 conventional GNU name for your system configuration---for example,
35 @samp{sparc-sun-sunos4.1}, for a Sun 4 running Sunos 4.1.
36 @xref{Installation, Installation, Installing GNU CC, gcc.info, Using and
37 Porting GNU CC}, for a full description of standard GNU configuration
38 names.
39
40 The GNU C Library currently supports configurations that match the
41 following patterns:
42
43 @example
44 sparc-sun-sunos4.@var{n}
45 m68k-hp-bsd4.3
46 m68k-sun-sunos4.@var{n}
47 m68k-sony-bsd4.3
48 mips-dec-ultrix4.@var{n}
49 i386-bsd4.3
50 i386-sysv
51 i386-sysv4
52 @end example
53
54 While no other configurations are supported, there are handy aliases for
55 these few.  (These aliases work in other GNU software as well.)
56
57 @example
58 sun4-sunos4.@var{n}
59 hp320-bsd4.3
60 sun3-sunos4.@var{n}
61 news
62 decstation-ultrix
63 i386-svr4
64 @end example
65
66 Here are some options that you should specify (if appropriate) when
67 you run @code{configure}:
68
69 @table @samp
70 @item --with-gnu-ld
71 Use this option if you plan to use GNU @code{ld} to link programs with
72 the GNU C Library.  (We strongly recommend that you do.)
73
74 @item --with-gnu-as
75 Use this option if you plan to use the GNU assembler, @code{gas}, when
76 building the GNU C Library.  On some systems, the library may not build
77 properly if you do @emph{not} use @code{gas}.
78
79 @c extra blank line makes it look better
80 @item --nfp
81
82 Use this option if your computer lacks hardware floating point support.
83
84 @item --prefix=@var{directory}
85 Install machine-independent data files in subdirectories of
86 @file{@var{directory}}.  (You can also set this in @file{configparms};
87 see below.)
88
89 @item --exec_prefix=@var{directory}
90 Install the library and other machine-dependent files in subdirectories
91 of @file{@var{directory}}.  (You can also set this in
92 @file{configparms}; see below.)
93 @end table
94
95 The simplest way to run @code{configure} is to do it in the directory
96 that contains the library sources.  This prepares to build the library
97 in that very directory.
98
99 You can prepare to build the library in some other directory by going
100 to that other directory to run @code{configure}.  In order to run
101 configure, you will have to specify a directory for it, like this:
102
103 @example
104 mkdir ../hp320
105 cd ../hp320
106 ../src/configure hp320-bsd4.3
107 @end example
108
109 @noindent
110 @code{configure} looks for the sources in whatever directory you
111 specified for finding @code{configure} itself.  It does not matter where
112 in the file system the source and build directories are---as long as you
113 specify the source directory when you run @code{configure}, you will get
114 the proper results.
115
116 This feature lets you keep sources and binaries in different
117 directories, and that makes it easy to build the library for several
118 different machines from the same set of sources.  Simply create a 
119 build directory for each target machine, and run @code{configure} in
120 that directory specifying the target machine's configuration name.
121
122 The library has a number of special-purpose configuration parameters.
123 These are defined in the file @file{Makeconfig}; see the comments in
124 that file for the details.
125
126 But don't edit the file @file{Makeconfig} yourself---instead, create a
127 file @file{configparms} in the directory where you are building the
128 library, and define in that file the parameters you want to specify.
129 @file{configparms} should @strong{not} be an edited copy of
130 @file{Makeconfig}; specify only the parameters that you want to
131 override.
132
133 Some of the machine-dependent code for some machines uses extensions in
134 the GNU C compiler, so you may need to compile the library with GCC.
135 (In fact, all of the existing complete ports require GCC.)
136
137 The current release of the C library contains some header files that the
138 compiler normally provides: @file{stddef.h}, @file{stdarg.h}, and
139 several files with names of the form @file{va-@var{machine}.h}.  The
140 versions of these files that came with older releases of GCC do not work
141 properly with the GNU C library.  The @file{stddef.h} file in release
142 2.2 and later of GCC is correct.  If you have release 2.2 or later of
143 GCC, use its version of @file{stddef.h} instead of the C library's.  To
144 do this, put the line @w{@samp{override stddef.h =}} in
145 @file{configparms}.  The other files are corrected in release 2.3 and
146 later of GCC.  If you release 2.3 or later of GCC, use its
147 @file{stdarg.h} and @file{va-@var{machine}.h} files instead of the C
148 library's.  To do this, put the line @w{@samp{override stdarg.h =}} in
149 @file{configparms}.
150
151 There is a potential problem with the @code{size_t} type and versions of
152 GCC prior to release 2.4.  ANSI C requires that @code{size_t} always be
153 an unsigned type.  For compatibility with existing systems' header
154 files, GCC defines @code{size_t} in @file{stddef.h} to be whatever type
155 the system's @file{sys/types.h} defines it to be.  Most Unix systems
156 that define @code{size_t} in @file{sys/types.h}, define it to be a
157 signed type.  Some code in the library depends on @code{size_t} being an
158 unsigned type, and will not work correctly if it is signed.
159
160 The GNU C library code which expects @code{size_t} to be unsigned is
161 correct.  The definition of @code{size_t} as a signed type is incorrect.
162 We plan that in version 2.4, GCC will always define @code{size_t} as an
163 unsigned type, and the @file{fixincludes} script will massage the
164 system's @file{sys/types.h} so as not to conflict with this.
165
166 In the meantime, the way to work around this problem is to tell GCC
167 explicitly to use an unsigned type for @code{size_t} when you compile
168 the GNU C library.  You can do this by compiling with
169 @samp{-D__SIZE_TYPE__='unsigned long int'}.  You can either put this
170 into the GCC @file{specs} file to affect all compilations using GCC, or
171 specify the flag just to compile the C library, with this line in
172 @file{configparms}:
173
174 @example
175 # Be sure to remember the 's to quote the spaces from the shell.
176 defines := -D__SIZE_TYPE__='unsigned long int'
177 @end example
178
179 @noindent
180 When you do this, the current version of GCC
181 will give you the annoying warning:
182
183 @example
184 *Initialization*:1: warning: `__SIZE_TYPE__' redefined
185 @end example
186
187 @noindent
188 It is safe to ignore this warning.  Version 2.3 of GCC is supposed to
189 fix this bug (the spurious warning---the type of @code{size_t} will not
190 be fixed until 2.4).
191
192 To build the library, type @code{make lib}.  This will produce a lot of
193 output, some of which looks like errors from @code{make} (but isn't).
194 Look for error messages from @code{make} containing @samp{***}.  Those
195 indicate that something is really wrong.  Using the @samp{-w} option to
196 @code{make} may make the output easier to understand (this option tells
197 @code{make} to print messages telling you what subdirectories it is
198 working on).@refill
199
200 To install the library and header files, type @code{make install}, after
201 setting the installation directories in @file{configparms}.  This will
202 build things if necessary, before installing them.@refill
203
204 @node Reporting Bugs
205 @appendixsec Reporting Bugs
206 @cindex reporting bugs
207
208 There are probably bugs in the GNU C library.  If you report them,
209 they will get fixed.  If you don't, no one will ever know about them
210 and they will remain unfixed for all eternity, if not longer.
211
212 To report a bug, first you must find it.  Hopefully, this will be the
213 hard part.  Once you've found a bug, make sure it's really a bug.  A
214 good way to do this is to see if the GNU C library behaves the same way
215 some other C library does.  If so, probably you are wrong and the
216 libraries are right (but not necessarily).  If not, one of the libraries
217 is probably wrong.
218
219 Once you're sure you've found a bug, try to narrow it down to the
220 smallest test case that reproduces the problem.  In the case of a C
221 library, you really only need to narrow it down to one library
222 function call, if possible.  This should not be too difficult.
223
224 The final step when you have a simple test case is to report the
225 bug.  When reporting a bug, send your test case, the results you
226 got, the results you expected, what you think the problem might be
227 (if you've thought of anything), your system type, and the version
228 of the GNU C library which you are using.
229
230 @ignore @c this makes no sense for `INSTALL' before the manual is out. --rm
231 If you are not sure how a function should behave, and this manual
232 doesn't tell you, that's a bug in the manual.  Report that too!
233 If the function's behavior disagrees with the manual, then either the
234 library or the manual has a bug, so report the disagreement.
235 @end ignore
236
237 If you think you have found some way in which the GNU C library does not
238 conform to the ANSI and POSIX standards (@pxref{Standards and
239 Portability}), that is definitely a bug.  Report it!@refill
240
241 Send bug reports to the Internet address
242 @samp{bug-glibc@@prep.ai.mit.edu} or the UUCP path
243 @samp{mit-eddie!prep.ai.mit.edu!bug-glibc}.  If you have other problems
244 with installation, use, or the documentation, please report those as
245 well.@refill
246
247 @node Source Layout
248 @appendixsec Adding New Functions
249
250 The process of building the library is driven by the makefiles, which
251 make heavy use of special features of GNU @code{make}.  The makefiles
252 are very complex, and you probably don't want to try to understand them.
253 But what they do is fairly straightforward, and only requires that you
254 define a few variables in the right places.
255
256 The library sources are divided into subdirectories, grouped by topic.
257 The @file{string} subdirectory has all the string-manipulation
258 functions, @file{stdio} has all the standard I/O functions, etc.
259
260 Each subdirectory contains a simple makefile, called @file{Makefile},
261 which defines a few @code{make} variables and then includes the global
262 makefile @file{Rules} with a line like:
263
264 @example
265 include ../Rules
266 @end example
267
268 @noindent
269 The basic variables that a subdirectory makefile defines are:
270
271 @table @code
272 @item subdir
273 The name of the subdirectory, for example @file{stdio}.
274 This variable @strong{must} be defined.
275
276 @item headers
277 The names of the header files in this section of the library,
278 such as @file{stdio.h}.
279
280 @item routines
281 @itemx aux
282 The names of the modules (source files) in this section of the library.
283 These should be simple names, such as @samp{strlen} (rather than
284 complete file names, such as @file{strlen.c}).  Use @code{routines} for
285 modules that define functions in the library, and @code{aux} for
286 auxiliary modules containing things like data definitions.  But the
287 values of @code{routines} and @code{aux} are just concatenated, so there
288 really is no practical difference.@refill
289
290 @item tests
291 The names of test programs for this section of the library.  These
292 should be simple names, such as @samp{tester} (rather than complete file
293 names, such as @file{tester.c}).  @w{@samp{make tests}} will build and
294 run all the test programs.  If a test program needs input, put the test
295 data in a file called @file{@var{test-program}.input}; it will be given to
296 the test program on its standard input.  If a test program wants to be
297 run with arguments, put the arguments (all on a single line) in a file
298 called @file{@var{test-program}.args}.@refill
299
300 @item others
301 The names of ``other'' programs associated with this section of the
302 library.  These are programs which are not tests per se, but are other
303 small programs included with the library.  They are built by
304 @w{@samp{make others}}.@refill
305
306 @item install-lib
307 @itemx install-data
308 @itemx install
309 Files to be installed by @w{@samp{make install}}.  Things listed in
310 @samp{install-lib} are installed in the directory specified by
311 @samp{libdir} in @file{Makeconfig} (@pxref{Installation}).  Files listed
312 in @code{install-data} are installed in the directory specified by
313 @samp{datadir} in @file{configparms} or @file{Makeconfig}.  Files listed
314 in @code{install} are installed in the directory specified by
315 @samp{bindir} in @file{Makeconfig}.@refill
316
317 @item distribute
318 Other files from this subdirectory which should be put into a
319 distribution tar file.  You need not list here the makefile itself or
320 the source and header files listed in the other standard variables.
321 Only define @code{distribute} if there are files used in an unusual way
322 that should go into the distribution.
323 @end table
324
325 @node Porting
326 @appendixsec Porting the GNU C Library
327
328 The GNU C library is written to be easily portable to a variety of
329 machines and operating systems.  Machine- and operating system-dependent
330 functions are well separated to make it easy to add implementations for
331 new machines or operating systems.  This section describes the layout of
332 the library source tree and explains the mechanisms used to select
333 machine-dependent code to use.
334
335 All the machine-dependent and operating system-dependent files in the
336 library are in the subdirectory @file{sysdeps} under the top-level
337 library source directory.  This directory contains a hierarchy of
338 subdirectories (@pxref{Hierarchy Conventions}).
339
340 Each subdirectory of @file{sysdeps} contains source files for a
341 particular machine or operating system, or for a class of machine or
342 operating system (for example, systems by a particular vendor, or all
343 machines that use IEEE 754 floating-point format).  A configuration
344 specifies an ordered list of these subdirectories.  Each subdirectory
345 implicitly appends its parent directory to the list.  For example,
346 specifying the list @file{unix/bsd/vax} is equivalent to specifying the
347 list @file{unix/bsd/vax unix/bsd unix}.  A subdirectory can also specify
348 that it implies other subdirectories which are not directly above it in
349 the directory hierarchy.  If the file @file{Implies} exists in a
350 subdirectory, it lists other subdirectories of @file{sysdeps} which are
351 appended to the list, appearing after the subdirectory containing the
352 @file{Implies} file.  Lines in an @file{Implies} file that begin with a
353 @samp{#} character are ignored as comments.  For example,
354 @file{unix/bsd/Implies} contains:@refill
355 @example
356 # BSD has Internet-related things.
357 unix/inet
358 @end example
359 @noindent
360 and @file{unix/Implies} contains:
361 @example
362 posix
363 @end example
364
365 @noindent
366 So the final list is @file{unix/bsd/vax unix/bsd vax unix/inet unix posix}.
367
368 @file{sysdeps} has two ``special'' subdirectories, called @file{generic}
369 and @file{stub}.  These two are always implicitly appended to the list
370 of subdirectories (in that order), so you needn't put them in an
371 @file{Implies} file, and you should not create any subdirectories under
372 them.  @file{generic} is for things that can be implemented in
373 machine-independent C, using only other machine-independent functions in
374 the C library.  @file{stub} is for @dfn{stub} versions of functions
375 which cannot be implemented on a particular machine or operating system.
376 The stub functions always return an error, and set @code{errno} to
377 @code{ENOSYS} (Function not implemented).  @xref{Error Reporting}.
378
379 A source file is known to be system-dependent by its having a version in
380 @file{generic} or @file{stub}; every system-dependent function should
381 have either a generic or stub implementation (there is no point in
382 having both).
383
384 If you come across a file that is in one of the main source directories
385 (@file{string}, @file{stdio}, etc.), and you want to write a machine- or
386 operating system-dependent version of it, move the file into
387 @file{sysdeps/generic} and write your new implementation in the
388 appropriate system-specific subdirectory.  Note that if a file is to be
389 system-dependent, it @strong{must not} appear in one of the main source
390 directories.@refill
391
392 There are a few special files that may exist in each subdirectory of
393 @file{sysdeps}:
394
395 @table @file
396 @item Makefile
397 A makefile for this machine or operating system, or class of machine or
398 operating system.  This file is included by the library makefile
399 @file{Makerules}, which is used by the top-level makefile and the
400 subdirectory makefiles.  It can change the variables set in the
401 including makefile or add new rules.  It can use GNU @code{make}
402 conditional directives based on the variable @samp{subdir} (see above) to
403 select different sets of variables and rules for different sections of
404 the library.  It can also set the @code{make} variable
405 @samp{sysdep-routines}, to specify extra modules to be included in the
406 library.  You should use @samp{sysdep-routines} rather than adding
407 modules to @samp{routines} because the latter is used in determining
408 what to distribute for each subdirectory of the main source tree.@refill
409
410 Each makefile in a subdirectory in the ordered list of subdirectories to
411 be searched is included in order.  Since several system-dependent
412 makefiles may be included, each should append to @samp{sysdep-routines}
413 rather than simply setting it:
414
415 @example
416 sysdep-routines := $(sysdep-routines) foo bar
417 @end example
418
419 @item Subdirs
420 This file contains the names of new whole subdirectories under the
421 top-level library source tree that should be included for this system.
422 These subdirectories are treated just like the system-independent
423 subdirectories in the library source tree, such as @file{stdio} and
424 @file{math}.
425
426 Use this when there are whole new sets of routines and header files that
427 should go into the library for the system this subdirectory of
428 @file{sysdeps} implements.  For example,
429 @file{sysdeps/unix/inet/Subdirs} contains @file{inet}; the @file{inet}
430 directory contains various network-oriented operations which only make
431 sense to put in the library on systems that support the Internet.@refill
432
433 @item Dist
434 This file contains the names of files (relative the the subdirectory of
435 @file{sysdeps} in which it appears) which should be included in the
436 distribution.  List any new files used by rules in the @file{Makefile}
437 in the same directory, or header files used by the source files in that
438 directory.  You don't need to list files that are implementations
439 (either C or assembly source) of routines whose names are given in the
440 machine-independent makefiles in the main source tree.
441 @end table
442
443 That is the general system for how system-dependencies are isolated.
444 @iftex
445 The next section explains how to decide what directories in
446 @file{sysdeps} to use.  @ref{Porting to Unix}, has some tips on porting
447 the library to Unix variants.
448 @end iftex
449
450 @menu
451 * Hierarchy Conventions::       The layout of the @file{sysdeps} hierarchy.
452 * Porting to Unix::             Porting the library to an average
453                                    Unix-like system.
454 @end menu
455
456 @node Hierarchy Conventions
457 @appendixsubsec The Layout of the @file{sysdeps} Directory Hierarchy
458
459 A GNU configuration name has three parts: the CPU type, the
460 manufacturer's name, and the operating system.  @file{configure} uses
461 these to pick the list of system-dependent directories to look for.  If
462 the @samp{--nfp} option is @emph{not} passed to @file{configure}, the
463 directory @file{@var{machine}/fpu} is also used.  The operating system
464 often has a @dfn{base operating system}; for example, if the operating
465 system is @samp{sunos4.1}, the base operating system is @samp{unix/bsd}.
466 The algorithm used to pick the list of directories is simple:
467 @file{configure} makes a list of the base operating system,
468 manufacturer, CPU type, and operating system, in that order.  It then
469 concatenates all these together with slashes in between, to produce a
470 directory name; for example, the configuration @w{@samp{sparc-sun-sunos4.1}}
471 results in @file{unix/bsd/sun/sparc/sunos4.1}.  @file{configure} then
472 tries removing each element of the list in turn, so
473 @file{unix/bsd/sparc} and @file{sun/sparc} are also tried, among others.
474 Since the precise version number of the operating system is often not
475 important, and it would be very inconvenient, for example, to have
476 identical @file{sunos4.1.1} and @file{sunos4.1.2} directories,
477 @file{configure} tries successively less specific operating system names
478 by removing trailing suffixes starting with a period.
479
480 Here is the complete list of directories that would be tried for the
481 configuration @samp{sparc-sun-sunos4.1}:
482
483 @example
484 @group
485 sparc/fpu
486 unix/bsd/sun/sunos4.1/sparc
487 unix/bsd/sun/sunos4.1
488 unix/bsd/sun/sunos4/sparc
489 unix/bsd/sun/sunos4
490 unix/bsd/sun/sparc
491 unix/bsd/sun
492 unix/bsd/sunos4.1/sparc
493 unix/bsd/sunos4.1
494 unix/bsd/sunos4/sparc
495 unix/bsd/sunos4
496 unix/bsd/sparc
497 unix/bsd
498 sun/sunos4.1/sparc
499 sun/sunos4.1
500 sun/sunos4/sparc
501 sun/sunos4
502 sun/sparc
503 sun
504 sunos4.1/sparc
505 sunos4.1
506 sunos4/sparc
507 sunos4
508 sparc
509 @end group
510 @end example
511
512 Different machine architectures are generally at the top level of the
513 @file{sysdeps} directory tree.  For example, @w{@file{sysdeps/sparc}}
514 and @w{@file{sysdeps/m68k}}.  These contain files specific to those
515 machine architectures, but not specific to any particular operating
516 system.  There might be subdirectories for specializations of those
517 architectures, such as @w{@file{sysdeps/m68k/68020}}. Code which is
518 specific to the floating-point coprocessor used with a particular
519 machine should go in @w{@file{sysdeps/@var{machine}/fpu}}.
520
521 There are a few directories at the top level of the @file{sysdeps}
522 hierarchy that are not for particular machine architectures.
523
524 @table @file
525 @item generic
526 @itemx stub
527 As described above (@pxref{Porting}), these are the two subdirectories
528 that every configuration implicitly uses after all others.
529
530 @item ieee754
531 This directory is for code using the IEEE 754 floating-point format,
532 where the C type @code{float} is IEEE 754 single-precision format, and
533 @code{double} is IEEE 754 double-precision format.  Usually this
534 directory is referred to in the @file{Implies} file in a machine
535 architecture-specific directory, such as @file{m68k/Implies}.
536
537 @item posix
538 This directory contains implementations of things in the library in
539 terms of @sc{POSIX.1} functions.  This includes some of the @sc{POSIX.1}
540 functions themselves.  Of course, @sc{POSIX.1} cannot be completely
541 implemented in terms of itself, so a configuration using just
542 @file{posix} cannot be complete.
543
544 @item unix
545 This is the directory for Unix-like things.  See @xref{Porting to Unix}.
546 @file{unix} implies @file{posix}.
547
548 @item mach
549 This is the directory for things based on the Mach microkernel from CMU
550 (including the GNU operating system).  Other basic operating systems
551 (VMS, for example) would have their own directories at the top level of
552 the @file{sysdeps} hierarchy, parallel to @file{unix} and @file{mach}.
553 @end table
554
555 @node Porting to Unix
556 @appendixsubsec Porting the GNU C Library to Unix Systems
557
558 Most Unix systems are fundamentally very similar.  There are variations
559 between different machines, and variations in what facilities are
560 provided by the kernel.  But the interface to the operating system
561 facilities is, for the most part, pretty uniform and simple.
562
563 The code for Unix systems is in the directory @file{unix}, at the top
564 level of the @file{sysdeps} hierarchy.  This directory contains
565 subdirectories (and subdirectory trees) for various Unix variants.
566
567 The functions which are system calls in most Unix systems are
568 implemented in assembly code in files in @file{sysdeps/unix}.  These
569 files are named with a suffix of @samp{.S}; for example,
570 @file{__open.S}.  Files ending in @samp{.S} are run through the C
571 preprocessor before being fed to the assembler.
572
573 These files all use a set of macros that should be defined in
574 @file{sysdep.h}.  The @file{sysdep.h} file in @file{sysdeps/unix}
575 partially defines them; a @file{sysdep.h} file in another directory must
576 finish defining them for the particular machine and operating system
577 variant.  See @file{sysdeps/unix/sysdep.h} and the machine-specific
578 @file{sysdep.h} implementations to see what these macros are and what
579 they should do.@refill
580
581 The system-specific makefile for the @file{unix} directory,
582 @file{sysdeps/unix/Makefile}, gives rules to generate several files from
583 the Unix system you are building the library on (which is assumed to be
584 the target system you are building the library @emph{for}).  All the
585 generated files are put in the directory where the object files are
586 kept; they should not affect the source tree itself.  The files
587 generated are @file{ioctls.h}, @file{errnos.h}, @file{sys/param.h}, and
588 @file{errlist.c} (for the @file{stdio} section of the library).
589
590 @ignore
591 @c This section might be a good idea if it is finished,
592 @c but there's no point including it as it stands. --rms
593 @c @appendixsec Compatibility with Traditional C
594
595 @c ??? This section is really short now.  Want to keep it? --roland
596
597 Although the GNU C library implements the ANSI C library facilities, you
598 @emph{can} use the GNU C library with traditional, ``pre-ANSI'' C
599 compilers.  However, you need to be careful because the content and
600 organization of the GNU C library header files differs from that of
601 traditional C implementations.  This means you may need to make changes
602 to your program in order to get it to compile.
603 @end ignore
604
605 @node Contributors
606 @appendixsec Contributors to the GNU C Library
607
608 The GNU C library was written almost entirely by Roland McGrath.
609 Some parts of the library were contributed by other people.
610
611 @itemize @bullet
612 @item
613 The @code{getopt} function and related code were written by
614 @w{Richard Stallman}, @w{David J. MacKenzie}, and @w{Roland McGrath}.
615
616 @item
617 Most of the math functions are taken from 4.4 BSD; they have been
618 modified only slightly to work with the GNU C library.  The
619 Internet-related code (most of the @file{inet} subdirectory) and several
620 other miscellaneous functions and header files have been included with
621 little or no modification.
622
623 All code incorporated from 4.4 BSD is under the following copyright:
624
625 @quotation
626 @display
627 Copyright @copyright{} 1991 Regents of the University of California.
628 All rights reserved.
629 @end display
630
631 Redistribution and use in source and binary forms, with or without
632 modification, are permitted provided that the following conditions
633 are met:
634
635 @enumerate
636 @item
637 Redistributions of source code must retain the above copyright
638 notice, this list of conditions and the following disclaimer.
639 @item
640 Redistributions in binary form must reproduce the above copyright
641 notice, this list of conditions and the following disclaimer in the
642 documentation and/or other materials provided with the distribution.
643 @item
644 All advertising materials mentioning features or use of this software
645 must display the following acknowledgement:
646 @quotation
647         This product includes software developed by the University of
648         California, Berkeley and its contributors.
649 @end quotation
650 @item
651 Neither the name of the University nor the names of its contributors
652 may be used to endorse or promote products derived from this software
653 without specific prior written permission.
654 @end enumerate
655
656 @sc{this software is provided by the regents and contributors ``as is'' and
657 any express or implied warranties, including, but not limited to, the
658 implied warranties of merchantability and fitness for a particular purpose
659 are disclaimed.  in no event shall the regents or contributors be liable
660 for any direct, indirect, incidental, special, exemplary, or consequential
661 damages (including, but not limited to, procurement of substitute goods
662 or services; loss of use, data, or profits; or business interruption)
663 however caused and on any theory of liability, whether in contract, strict
664 liability, or tort (including negligence or otherwise) arising in any way
665 out of the use of this software, even if advised of the possibility of
666 such damage.}
667 @end quotation
668
669 @item
670 The random number generation functions @code{random}, @code{srandom},
671 @code{setstate} and @code{initstate}, which are also the basis for the
672 @code{rand} and @code{srand} functions, were written by Earl T. Cohen
673 for the University of California at Berkeley and are copyrighted by the
674 Regents of the University of California.  They have undergone minor
675 changes to fit into the GNU C library and to fit the ANSI C standard,
676 but the functional code is Berkeley's.@refill
677
678 @item
679 The merge sort function @code{qsort} was written by Michael J. Haertel.
680
681 @item
682 The quick sort function used as a fallback by @code{qsort} was written
683 by Douglas C. Schmidt.
684
685 @item
686 The memory allocation functions @code{malloc}, @code{realloc} and
687 @code{free} and related code were written by Michael J. Haertel.
688
689 @item
690 Fast implementations of many of the string functions (@code{memcpy},
691 @code{strlen}, etc.) were written by
692 @tex
693 Torbj\"orn
694 @end tex
695 @ifinfo
696 Torbjorn
697 @end ifinfo
698 Granlund.@refill
699
700 @item
701 Some of the support code for Mach is taken from Mach 3.0 by CMU,
702 and is under the following copyright terms:
703
704 @quotation
705 @display
706 Mach Operating System
707 Copyright @copyright{} 1991,1990,1989 Carnegie Mellon University
708 All Rights Reserved.
709 @end display
710
711 Permission to use, copy, modify and distribute this software and its
712 documentation is hereby granted, provided that both the copyright
713 notice and this permission notice appear in all copies of the
714 software, derivative works or modified versions, and any portions
715 thereof, and that both notices appear in supporting documentation.
716
717 @sc{carnegie mellon allows free use of this software in its ``as is''
718 condition.  carnegie mellon disclaims any liability of any kind for
719 any damages whatsoever resulting from the use of this software.}
720
721 Carnegie Mellon requests users of this software to return to
722
723 @display
724  Software Distribution Coordinator
725  School of Computer Science
726  Carnegie Mellon University
727  Pittsburgh PA 15213-3890
728 @end display
729
730 @noindent
731 or @samp{Software.Distribution@@CS.CMU.EDU} any improvements or
732 extensions that they make and grant Carnegie Mellon the rights to
733 redistribute these changes.
734 @end quotation
735
736 @item
737 The @file{tar.h} header file was written by David J. MacKenzie.
738
739 @item
740 The port to the MIPS DECStation running Ultrix 4 was contributed by
741 Brendan Kehoe and Ian Lance Taylor.
742
743 @item
744 The DES encryption function @code{crypt} and related functions were
745 contributed by Michael Glad.
746
747 @item
748 The @code{ftw} function was contributed by Ian Lance Taylor.
749
750 @item
751 The code to support SunOS shared libraries was contributed by Tom Quinn.
752 @end itemize
753
754 @c @bye