changeset 9949:a6308dcad5ac

update HACKING file
author John W. Eaton <jwe@octave.org>
date Wed, 09 Dec 2009 12:37:50 -0500
parents 6e17093431f5
children 7dedfd70dd9f
files ChangeLog HACKING
diffstat 2 files changed, 23 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog	Wed Dec 09 02:38:37 2009 -0500
+++ b/ChangeLog	Wed Dec 09 12:37:50 2009 -0500
@@ -1,3 +1,7 @@
+2009-12-09  John W. Eaton  <jwe@octave.org>
+
+	* HACKING: Clarify gnulib checkout and use.
+
 2009-12-09  John W. Eaton  <jwe@octave.org>
 
 	* configure.ac: Remove URL argument from AC_INIT.
--- a/HACKING	Wed Dec 09 02:38:37 2009 -0500
+++ b/HACKING	Wed Dec 09 12:37:50 2009 -0500
@@ -53,8 +53,25 @@
 from gnulib but is kept in the Octave source archive.  It should be
 updated from the gnulib source as necssary.  The bootstrap script takes
 care of checking out a copy of gnulib, running the autotools, and
-generating the configure script.  Once the autogen.sh and bootstrap
-scripts complete successfully, you may run
+generating the configure script.
+
+If you have a copy of gnulib in some directory apart from the Octave
+source tree, then pass the name of that directory to the bootstrap
+script using the
+
+  --gnulib-srcdir=DIRNAME
+
+option (all options passed to autogen.sh are forwarded to the
+bootstrap script).  This way, you can share a single gnulib source
+tree among several projects.  Regardless of the location of the gnulib
+sources, the bootstrap script will try to update them if it appears
+that they are checked out using git.  Otherwise, it is your
+responsibility to keep the gnulib sources up to date.  They change
+frequently, so the best way to stay current is probably to use git to
+do the job.
+
+Once the autogen.sh and bootstrap scripts complete successfully, you may
+run
 
   $ ./configure
   $ make