Changeset 1596 for trunk/run_autotools

Timestamp:

Jul 8, 2010 8:40:44 PM (11 years ago)

Author:

lou

Message:

Make run_autotools less aggressive about installing autotools auxilliary
scripts. Add ability to force installation. Rework handling of temporary links
to BuildTools? so that it's compatible with old and new styles of packaging.

File:

• trunk/run_autotools (modified) (12 diffs)

trunk/run_autotools

@@ -15 +15 @@
 #      Directories specified on the command line are recursively searched
 #      for configure.ac files. Install-sh signals an independent unit.
+# Modified: Lou Hafer          SFU      2010-07-08
+#      More mods to maintain flexibility but be a bit less aggressive about
+#      forcing installation of autotools auxilliary scripts. Also add some
+#      command line options and restore ability to specify individual
+#      directories on the command line.
 
 # run_autotools takes care of running the autotools (automake, autoconf,
@@ -20 +25 @@
 # libtool execute at configuration, build, and installation.
 
-# The operating assumption is that run_autotools is run in the top level of a
-# directory tree, and that directory tree is the top of an independent unit. If
-# there is no BuildTools subdirectory present, run_autotools will create
-# a link to the directory where it lives, which is assumed to be a BuildTools
-# directory somewhere else. The advantage to this approach is that BuildTools
-# appears to live in a known location (constant within the directory tree
-# of the unit).  This is necessary for proper handling by automake of some
-# standard COIN includes in Makefile.am which reference files in BuildTools.
-# run_autotools will also copy a number of autotools scripts (required for
-# build and installation of any independent unit) from BuildTools into the
-# directory where it is run. This, too, is required. The location of these
-# files is frozen when automake and autoconf run, and they must move with
-# the independent unit because they will be required when configure is run
-# and the unit is built and installed.
-
-# Subdirectories are searched for configure.ac files. Autotools will be run
-# in these directories if any AC_COIN_ macro is present in the configure.ac
-# file. Should it be necessary to fool this script into processing a file that
-# otherwise contains no COIN macros, just add a line with AC_COIN_.
+# Run_autotools can be given a set of directories on the command line; if none
+# are specified, it assumes the current directory (`,').  Subdirectories are
+# searched for configure.ac files unless suppressed with the -nr option.
+# Autotools will consider a directory for processing if any AC_COIN_ macro is
+# present in the configure.ac file. Should it be necessary to fool this script
+# into processing a file that otherwise contains no COIN macros, just add a
+# line with AC_COIN_.  The resulting list is winnowed to remove directories
+# specified in COIN_SKIP_PROJECTS.
+
+# Each directory processed gets a temporary link to BuildTools, unless a
+# BuildTools subdirectory is already present. Mostly this is a convenience, but
+# one thing makes it mandatory: Many Makefile.am files in COIN use an include
+# directive to pull in BuildTools/Makemain.inc. There's no way I (lh) can see
+# to alter the path that's hardcoded in the include directive. Just to make it
+# more interesting, COIN projects are generally constructed with the assumption
+# that BuildTools will be one or two directories up, so you'll see things like
+# `include ../BuildTools/Makemain.inc'. run_autotools doesn't understand this
+# hierarchy, so it keeps all those temporary BuildTools links until the very
+# end. That way, it works with the old-style COIN organisation where a
+# BuildTools directory is pulled in as an external in the top directory of a
+# package, and with the new-style independent organisation, where there may be
+# only a single copy of BuildTools out there somewhere.
 
 # If any subdirectory queued for processing is found to contain an install-sh
-# script, it is treated as an independent unit (BuildTools link and script
-# copies).
+# script, it is treated as an independent unit (i.e., you can run `make
+# install' from this directory) and the set of auxilliary scripts is refreshed
+# from BuildTools.  You can force installation of install-sh and associated
+# scripts with the -i option. It's good to read the autoconf documentation for
+# AC_CONFIG_AUX_DIR if this doesn't make sense to you.
 
 # Make sure we bail out if there is an error
@@ -51 +62 @@
 
 cleanupOnErrorExit ()
-{ for link in $topLink $subLink ; do
+{ for link in $buildtoolsLinks; do
     echo Trap: removing $link
     rm -f $link
@@ -63 +74 @@
 # the command name, we're running in the current directory (almost certainly
 # not what's wanted). Otherwise, strip the command name, leaving the prefix.
+# Convert the prefix to an absolute path, if needed, and clean it up, removing
+# `XXX/..', '/./', '//' sequences.
 
 startDir=`pwd`
@@ -70 +83 @@
   runautotoolDir='.'
 fi
-runautotoolDir=$startDir/$runautotoolDir
+if  expr "$runautotoolDir" : '/.*' >/dev/null 2>&1 ; then
+  :
+else
+  runautotoolDir=$startDir/$runautotoolDir
+fi
 while expr "$runautotoolDir" : '.*/\.\./.*' >/dev/null 2>&1 ; do
   runautotoolDir=`echo $runautotoolDir | sed -e 's,/[^/][^/]*/\.\./,/,'`
 done
-
-# Determine the location of BuildTools. If there's a BuildTools subdirectory
-# in the current directory, that's it.  Otherwise, assume that runautotooldDir
-# is BuildTools. Allow that the user may have linked to a BuildTools.
-
-createLink=0
-if test -d BuildTools || test -L BuildTools ; then
-  toolsDir=BuildTools
-else
-  createLink=1
-  toolsDir=$runautotoolDir
-fi
-
-# Create an absolute path if we don't have one, because we'll be moving
-# around. Clean up the path by removing `XXX/..', '/./', '//' sequences.
-
-if expr "$toolsDir" : '/.*' >/dev/null 2>&1 ; then
-  :
-else
-  toolsDir=$startDir/$toolsDir
-fi
-while expr "$toolsDir" : '.*/\.\./.*' >/dev/null 2>&1 ; do
-  toolsDir=`echo $toolsDir | sed -e 's,/[^/][^/]*/\.\./,/,'`
-done
-toolsDir=`echo $toolsDir | sed -e 's,/\./,/,g' -e 's,//,/,g'`
-
-# Test to be sure that run_autotools is coming from the BuildTools directory.
-
-if test $createLink = 0 && test "$toolsDir" != "$runautotoolDir" ; then
-  echo "WARNING: using run_autotools from $runautotoolDir"
-  echo "         but BuildTools is $toolsDir."
-  echo "         Consider carefully if this is what you wanted to do."
-fi
-
-echo "BuildTools directory: $toolsDir"
-
-# coin.m4 should live in the same directory, but this failure is fatal.
-
-if test ! -r $toolsDir/coin.m4 ; then
-  echo "Cannot find Coin autotools macro file $toolsDir/coin.m4. It should"
-  echo "be in the BuildTools directory."
-  exit 1
-fi
-
-# As is the failure to find the correct versions of autoconf or automake.
+runautotoolDir=`echo $runautotoolDir | sed -e 's,/\./,/,g' -e 's,//,/,g'`
+
+# Make sure we're using the correct versions of the autotools. Failure to
+# satisfy this requirement is a fatal error.
 
 ver_autoconf='2.59'
@@ -176 +152 @@
 printHelp=0
 doRecurse=1
+forceScripts=0
 userSpecifiedDirs=0
 dirsToProcess=
@@ -190 +167 @@
          doRecurse=0
          ;;
-     -* ) echo "$0: unrecognised command line switch '"$1"'."
-          printHelp=1
-          ;;
-      * ) dirsToProcess="$dirsToProcess $1"
-          userSpecifiedDirs=1
-          ;;
+    -i | --independent )
+         forceScripts=1
+         doRecurse=0
+         ;;
+    -* ) echo "$0: unrecognised command line switch '"$1"'."
+         printHelp=1
+         ;;
+     * ) dirsToProcess="$dirsToProcess $1"
+         userSpecifiedDirs=1
+         ;;
   esac
   shift
@@ -208 +189 @@
   -h  | --help           print help message and exit
   -nr | --no-recursion   do not do recursive search for configure.ac files
+  -i  | --independent    install scripts necessary for an independent unit
 
   If no directories are specified, the tree rooted at the current directory
@@ -218 +200 @@
   If directories are specified on the command line *and* --no-recursion is
   given, the specified directories are processed with no checks.
+
+  The --independent option will force installation of install-sh and other
+  scripts necessary for a unit that is installed independently. This will
+  be forced in *all* directories processed. Most often what is desired is
+  to install these scripts in the top-level directory of a unit, so -i
+  forces -nr. It's a good idea to explicitly specify the directories you want
+  to process.
 EOF
   exit
@@ -305 +294 @@
 echo "Running autotools in $dirs"
 
-if test $createLink = 1 ; then
-  echo "Creating temporary link for ./BuildTools -> $toolsDir"
-  ln -s $toolsDir BuildTools
-  topLink="$startDir/BuildTools"
-fi
-
-# Copy over files that are used during configure, build, and install. Their
-# location will be frozen in files created by automake and autoconf, so they
-# must be present in order to move with the directory tree.
+# And now the main event. Process each directory.
+
+echo "Running autotools in $dirs"
 
 autotoolsFiles="config.guess config.sub depcomp install-sh ltmain.sh missing"
-echo "Copying autotools scripts into this directory."
-for file in $autotoolsFiles ; do
-  cp BuildTools/$file .
-done
-
-# And now the main event.  Presence of install-sh in a directory is the
-# trigger for processing as an independent unit.
-
-echo "Running autotools in $dirs"
-
-m4Files="$AUTOTOOLS_DIR/share/aclocal/libtool.m4 $toolsDir/coin.m4"
+m4Files="$AUTOTOOLS_DIR/share/aclocal/libtool.m4"
+buildtoolsLinks=
+
 for dir in $dirs; do
   if test -r $dir/configure.ac; then
     cd $dir
-    tmpBT=0
     echo "Processing $dir ..."
-    # Avoid repeat actions for current directory (".")
-    if test -f install-sh && test "$dir" != "." ; then
-      if test ! -d BuildTools ; then
+
+# Do we need a BuildTools subdirectory here? The criteria is that install-sh
+# already exists, or Makefile.am (which may include Makemain.inc), or we're
+# forcing installation of the configure scripts.  Assuming we need BuildTools,
+# what BuildTools should we use? If a BuildTools is already present, that's
+# it.  Otherwise, assume that runautotooldDir is BuildTools. Allow that the
+# user may have linked to a BuildTools.
+
+    needScripts=0
+    if test -f install-sh || test $forceScripts = 1 ; then
+      needScripts=1
+    fi
+    if test -f Makefile.am || test $needScripts = 1 ; then
+      if test -d BuildTools || test -L BuildTools ; then
+        createLink=0
+        toolsDir=`pwd`/BuildTools
+      else
+        createLink=1
+        toolsDir=$runautotoolDir
+      fi
+      echo "  BuildTools directory: $toolsDir"
+
+# Test to be sure that run_autotools is coming from the BuildTools directory.
+
+      if test $createLink = 0 && test "$toolsDir" != "$runautotoolDir" ; then
+        echo "WARNING: using run_autotools from $runautotoolDir"
+        echo "         but BuildTools is $toolsDir."
+        echo "         Consider carefully if this is what you wanted to do."
+      fi
+
+# coin.m4 should live in the same directory; failure is fatal.
+
+      if test ! -r $toolsDir/coin.m4 ; then
+        echo "Cannot find Coin autotools macro file $toolsDir/coin.m4."
+        echo "It should be in the BuildTools directory."
+        exit 1
+      fi
+
+# Install a link, if needed.
+
+      if test $createLink = 1 ; then
         ln -s $toolsDir BuildTools
-        tmpBT=1
-        subLink="`pwd`/BuildTools"
+        buildtoolsLinks="$buildtoolsLinks `pwd`/BuildTools"
         echo "  creating temporary link for ./BuildTools -> $toolsDir"
       fi
-      echo "  refreshing autotools scripts in this directory."
-      for file in $autotoolsFiles ; do
-        cp BuildTools/$file .
-      done
+
+# And refresh the autotools scripts, if needed.
+
+      if test $needScripts = 1 ; then
+        echo "  refreshing autotools scripts in this directory."
+        for file in $autotoolsFiles ; do
+          cp BuildTools/$file .
+        done
+      fi
+
     fi
+
+# Get on with running the autotools.
+
     echo "  creating acinclude.m4 in $dir"
-    cat $m4Files > acinclude.m4
+    cat $m4Files $toolsDir/coin.m4 > acinclude.m4
     echo "  running aclocal in $dir"
     if test -d m4; then
@@ -361 +381 @@
     echo "  running autoconf in $dir"
     autoconf || exit 1
-    if test $tmpBT = 1 ; then
-      echo "  removing temporary link for ./BuildTools"
-      rm BuildTools
-      subLink=
-    fi
     cd $startDir
   else
@@ -373 +388 @@
 done
 
-if test $createLink = 1 ; then
-  echo "Removing temporary link for ./BuildTools"
-  rm BuildTools
-  topLink=
-fi
-
+# Remove the links. Yeah, the trap will do this, but it never hurts to clean
+# up properly.
+
+if test -n $buildtoolsLinks ; then
+  echo "Removing temporary links to BuildTools."
+  for link in $buildtoolsLinks ; do
+    # echo "  removing temporary link for BuildTools: $link"
+    rm $link
+  done
+  buildtoolsLinks=
+fi
+
+exit
+