lib/autobuild/packages/autotools.rb in autobuild-1.0 vs lib/autobuild/packages/autotools.rb in autobuild-1.0.1

@@ -12,22 +12,16 @@
         
     # 
     # ==== Handles autotools-based packages
     #
     # == Used programs (see <tt>Autobuild.programs</tt>)
-    # * aclocal
-    # * autoheader
-    # * autoconf
-    # * automake
+    # Autotools will use the 'aclocal', 'autoheader', 'autoconf' and 'automake'
+    # programs defined on Autobuild.programs. autoheader is disabled by default,
+    # aclocal, autoconf and automake use are autodetected.
     #
-    # == Available options
-    # * aclocal     (default: true if autoconf is enabled, false otherwise) run aclocal
-    # * autoconf    (default: true)
-    # * autoheader  (default: false) run autoheader
-    # * automake    (default: autodetect) run automake. Will run automake if there is a 
-    #               +Makefile.am+ in the source directory
-    # 
+    # To override this default behaviour on a per-package basis, use Autotools#use
+    #
     class Autotools < Package
         attr_accessor   :using
         attr_accessor   :configureflags
         class << self
             attr_reader :builddir
@@ -59,9 +53,32 @@
             super
 
             Autobuild.update_environment(prefix)
         end
 
+	# Overrides the default behaviour w.r.t. autotools script generation
+	#
+	# Use it like that:
+	# * to force a generation step (skipping autodetection), do
+	#     pkg.use <program> => true
+	#   For instance, for aclocal
+	#     pkg.use :aclocal => true
+	#
+	# * to force a generation step, overriding the program defined on Autobuild
+	#     pkg.use <program> => true
+	#   For instance, for autoconf
+	#     pkg.use :autoconf => 'my_autoconf_program'
+	#
+	# * to disable a generation step, do
+	#     pkg.use <program> => false
+	#   For instance, for automake
+	#     pkg.use :automake => false
+	#
+	# * to restore autodetection, do
+	#     pkg.use <program> => nil
+	#   For instance, for automake
+	#     pkg.use :automake => nil
+	#
         def use(*programs)
             programs = *programs
             if !programs.kind_of?(Hash)
                 programs = Array[*programs].inject({}) do |programs, spec|
                     programs[spec.first] = spec.last