2007-04-12 Simon Josefsson <simon@josefsson.org>
[gnulib.git] / doc / gnulib.texi
index 22b4cf7..294dc73 100644 (file)
@@ -1,5 +1,5 @@
 \input texinfo   @c -*-texinfo-*-
-@comment $Id: gnulib.texi,v 1.31 2007-01-03 18:51:20 karl Exp $
+@comment $Id: gnulib.texi,v 1.36 2007-04-03 22:45:13 haible Exp $
 @comment %**start of header
 @setfilename gnulib.info
 @settitle GNU Gnulib
@@ -7,7 +7,7 @@
 @syncodeindex pg cp
 @comment %**end of header
 
-@set UPDATED $Date: 2007-01-03 18:51:20 $
+@set UPDATED $Date: 2007-04-03 22:45:13 $
 
 @copying
 This manual is for GNU Gnulib (updated @value{UPDATED}),
@@ -68,7 +68,7 @@ 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
@@ -101,6 +101,7 @@ Resources:
 * Windows sockets::
 * Libtool and Windows::
 * License Texinfo sources::
+* Build robot for gnulib::
 @end menu
 
 
@@ -201,16 +202,16 @@ library has chosen to adopt a different strategy.  Out of memory
 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
@@ -354,6 +355,63 @@ option to @command{gnulib-tool}.
 
 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 ./autobuild (or "nohup ./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
@@ -365,6 +423,7 @@ Of course the license texts themselves should not be changed at all.
 * gcd::
 * inet_ntoa::
 * Regular expressions::
+* Supporting Relocation::
 @end menu
 
 @include quote.texi
@@ -372,6 +431,7 @@ Of course the license texts themselves should not be changed at all.
 @include ctime.texi
 @include gcd.texi
 @include inet_ntoa.texi
+@include relocatable-maint.texi
 
 @node Regular expressions
 @section Regular expressions