\input texinfo @c -*-texinfo-*-
-@comment $Id: gnulib.texi,v 1.28 2006-10-23 11:26:25 haible Exp $
+@comment $Id: gnulib.texi,v 1.37 2007-04-12 13:01:59 jas Exp $
@comment %**start of header
@setfilename gnulib.info
@settitle GNU Gnulib
@syncodeindex pg cp
@comment %**end of header
-@set UPDATED $Date: 2006-10-23 11:26:25 $
+@set UPDATED $Date: 2007-04-12 13:01:59 $
@copying
This manual is for GNU Gnulib (updated @value{UPDATED}),
which is a library of common routines intended to be shared at the
source level.
-Copyright @copyright{} 2004, 2005, 2006 Free Software Foundation, Inc.
+Copyright @copyright{} 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
-@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation; with no
-Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
-and with the Back-Cover Texts as in (a) below. A copy of the
-license is included in the section entitled ``GNU Free Documentation
-License.''
-
-(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
-this GNU Manual, like GNU software. Copies published by the Free
-Software Foundation raise funds for GNU development.''
-@end quotation
+Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
+Texts. A copy of the license is included in the section entitled
+``GNU Free Documentation License.''
@end copying
@dircategory Software development
@menu
* Introduction::
* Invoking gnulib-tool::
-* Miscellanous Notes::
+* Miscellaneous Notes::
* Particular Modules:: Documentation of Individual Modules
* Copying This Manual::
* Index::
@end menu
-
@node Introduction
@chapter Introduction
-Getting started:
+Gnulib is a source code library. It provides basic functionalities to
+programs and libraries. Currently (as of October 2006) more than 30
+packages make use of Gnulib.
+
+Resources:
@itemize
@item Gnulib is hosted at Savannah:
@url{http://savannah.gnu.org/projects/gnulib}. Get the sources
- through CVS from there.
+ through git or CVS from there.
@item The Gnulib home page:
@url{http://www.gnu.org/software/gnulib/}.
@end itemize
+@menu
+* Library vs. Reusable Code::
+* Portability and Application Code::
+* Modules::
+* Various Kinds of Modules::
+* Collaborative Development::
+* Copyright::
+* Steady Development::
+* Openness::
+@end menu
+
+@include gnulib-intro.texi
+
@include gnulib-tool.texi
-@node Miscellanous Notes
-@chapter Miscellanous Notes
+@node Miscellaneous Notes
+@chapter Miscellaneous Notes
@menu
* Comments::
* Windows sockets::
* Libtool and Windows::
* License Texinfo sources::
+* Build robot for gnulib::
@end menu
handling happens in rare situations, but performing the out of memory
error handling after almost all API function invocations pollute your
source code and might make it harder to spot more serious problems.
-The strategy chosen improve code readability and robustness.
+The strategy chosen improves code readability and robustness.
@cindex Aborting execution
For most applications, aborting the application with an error message
-when the out of memory situation occur is the best that can be wished
+when the out of memory situation occurs is the best that can be wished
for. This is how the library behaves by default.
@vindex xalloc_fail_func
However, we realize that some applications may not want to have the
-GSS library abort execution in any situation. The GSS library support
+GSS library abort execution in any situation. The GSS library supports
a hook to let the application regain control and perform its own
cleanups when an out of memory situation has occurred. The application
can define a function (having a @code{void} prototype, i.e., no return
Of course the license texts themselves should not be changed at all.
+@node Build robot for gnulib
+@section Build robot for gnulib
+
+To simplify testing on a wide set of platforms, gnulib is built on
+many platforms every day and the results are uploaded to:
+
+@url{http://autobuild.josefsson.org/gnulib/}
+
+If you wish to help the gnulib development effort with build logs for
+your favorite platform, you may perform these steps:
+
+@enumerate
+
+@item Create gnulib directory
+
+On a machine with recent automake, autoconf, m4 installed and with a
+gnulib git or cvs checkout (typically a Linux machine), use
+
+@example
+gnulib-tool --create-megatestdir --with-tests --dir=..."
+@end example
+
+Note: The created directory uses ca. 512 MB on disk.
+
+@item Transfer gnulib directory
+
+Transfer this directory to a build machine (HP-UX, Cygwin, or
+whatever). Often it is easier to transfer one file, and this can be
+achieved by running, inside the directory the following commands:
+
+@example
+./configure
+make dist
+@end example
+
+And then transferring the @file{dummy-0.tar.gz} file.
+
+@item Build modules
+
+On the build machine, run ./do-autobuild (or "nohup ./do-autobuild").
+It creates a directory 'logs/' with a log file for each module.
+
+@item Submit build logs
+
+Submit each log file to Simon's site, either through a
+
+@example
+mail `echo gnulib__at__autobuild.josefsson.org | sed -e s/__at__/@@/`
+@end example
+
+or through netcat
+
+@example
+autobuild-submit logs/*
+@end example
+
+@end enumerate
@node Particular Modules
@chapter Particular Modules
@menu
* Quoting::
* ctime::
+* error and progname::
* gcd::
* inet_ntoa::
* Regular expressions::
+* Supporting Relocation::
@end menu
@include quote.texi
-
+@include error.texi
@include ctime.texi
-
@include gcd.texi
-
@include inet_ntoa.texi
+@include relocatable-maint.texi
@node Regular expressions
@section Regular expressions
projects / gnulib.git / blobdiff