autobuild 1.2.3 → 1.2.4

data/Changes.txt

@@ -1,3 +1,12 @@
+== Version 1.2.4
+* git update phase now fetches the repository and branch specified by the
+  autobuild script. It previously was using remote tracking branches. This
+  will allow to detect branch changes in the autobuild specification.
+* documentation support. Packages can now declare that they can generate
+  documentation (see Package#doc_task and CMake#with_doc). That documentation
+  is generated post-build and installed.
+* fix build updates in the CMake package class.
+
 == Version 1.2.3
 * Fix git update again. FETCH_HEAD may resolve as an ID which is not the one
   to be selected for merge

data/bin/autobuild

@@ -36,8 +36,13 @@ begin
             end
 	end
 
-	targets  = ['import']
-	targets += ['prepare', 'build'] if Autobuild.do_build
+        if Autobuild.only_doc
+            targets  = ['doc']
+        else
+            targets  = ['import']
+            targets << 'doc' if Autobuild.do_doc
+            targets += ['prepare', 'build'] if Autobuild.do_build
+        end
         targets.each do |phase|
 	    packages = Autobuild.packages
 	    packages = Autobuild.default_packages if packages.empty?

data/lib/autobuild.rb

@@ -3,6 +3,6 @@ require 'autobuild/reporting'
 require 'autobuild/package'
 
 module Autobuild
-    VERSION = "1.2.3" unless defined? Autobuild::VERSION
+    VERSION = "1.2.4" unless defined? Autobuild::VERSION
 end
 

data/lib/autobuild/config.rb

@@ -26,8 +26,9 @@ end
 module Autobuild
     class << self
         %w{ nice srcdir prefix
-            verbose debug do_update do_build
-            daemonize clean_log packages default_packages }.each do |name|
+            verbose debug do_update do_build only_doc do_doc
+            daemonize clean_log packages default_packages
+            doc_prefix }.each do |name|
             attr_accessor name
         end
 
@@ -35,11 +36,18 @@ module Autobuild
         attr_reader :programs
 	# The directory in which logs are saved. Defaults to PREFIX/log.
         attr_writer :logdir
+
+        # True if we build and if the build is applied on all packages
+        def full_build?
+            do_build && !only_doc && packages.empty?
+        end
     end
     DEFAULT_OPTIONS = { :nice => 0,
         :srcdir => Dir.pwd, :prefix => Dir.pwd, :logdir => nil,
         :verbose => false, :debug => false, :do_build => true, :do_update => true, 
-        :daemonize => false, :packages => [], :default_packages => [] }
+        :daemonize => false, :packages => [], :default_packages => [],
+        :only_doc => false, :do_doc => true,
+        :doc_prefix => 'doc' }
 
     @programs = Hash.new
     DEFAULT_OPTIONS.each do |name, value|
@@ -143,8 +151,10 @@ module Autobuild
 		if defined? Daemons
 		    opts.on("--[no-]daemon", "go into daemon mode") do |@daemonize| end
 		end
-                opts.on("--[no-]update", "update already checked-out sources") do |@do_update| end
-                opts.on("--[no-]build",  "only prepare packages, do not build them") do |@do_build| end 
+                opts.on("--no-update", "update already checked-out sources") do |@do_update| end
+                opts.on("--no-build",  "only prepare packages, do not build them") do |@do_build| end 
+                opts.on("--only-doc", "only generate documentation") do |@only_doc| end
+                opts.on("--no-doc", "don't generate documentation") do |@doc_doc| end
 
                 opts.separator ""
                 opts.separator "Program output"

data/lib/autobuild/configurable.rb

@@ -46,22 +46,7 @@ module Autobuild
 
         def initialize(options)
             super
-            Autobuild.update_environment(prefix)
-        end
-
-        def depends_on(*packages)
-            super
-            stamps = packages.collect { |p| Package[p.to_s].installstamp }
-            file configurestamp => stamps
-        end
 
-        def ensure_dependencies_installed
-            dependencies.each do |pkg|
-                Rake::Task[Package[pkg].installstamp].invoke
-            end
-        end
-
-        def prepare
             file configurestamp do
                 ensure_dependencies_installed
                 configure
@@ -75,11 +60,29 @@ module Autobuild
                 ensure_dependencies_installed
                 build
             end
+            task "#{name}-build" => buildstamp
 
             file installstamp => buildstamp do 
                 install
                 Autobuild.update_environment(prefix)
             end
+
+            Autobuild.update_environment(prefix)
+        end
+
+        def depends_on(*packages)
+            super
+            stamps = packages.collect { |p| Package[p.to_s].installstamp }
+            file configurestamp => stamps
+        end
+
+        def ensure_dependencies_installed
+            dependencies.each do |pkg|
+                Rake::Task[Package[pkg].installstamp].invoke
+            end
+        end
+
+        def prepare
         end
 
         # Configure the builddir directory before starting make

data/lib/autobuild/import/git.rb

@@ -35,7 +35,7 @@ module Autobuild
                 end
 
                 # Fetch and merge if the merge leads to a fast-forward
-                Subprocess.run(package.name, :import, Autobuild.tool('git'), 'fetch')
+                Subprocess.run(package.name, :import, Autobuild.tool('git'), 'fetch', repository, branch)
                 if !File.readable?( File.join('.git', 'FETCH_HEAD') )
                     return
                 end

data/lib/autobuild/package.rb

@@ -63,6 +63,9 @@ module Autobuild
 
 	    # Call the config block (if any)
 	    yield(self) if block_given?
+
+            @doc_dir        ||= 'doc'
+            @doc_target_dir ||= name
 	    
 	    # Declare the installation stampfile
 	    file installstamp do
@@ -88,6 +91,9 @@ module Autobuild
 		Rake::Task["#{name}-import"].invoke
 		Rake::Task["#{name}-prepare"].invoke
 		Rake::Task["#{name}-build"].invoke
+                if has_doc? && !Autobuild.no_doc
+                    Rake::Task["#{name}-doc"].invoke
+                end
 	    end
 	    task :default => name
 	end
@@ -95,6 +101,69 @@ module Autobuild
 	def import; @importer.import(self) if @importer end
 	def prepare; end
 
+        # Directory in which the documentation target will have generated the
+        # documentation (if any). The interpretation of relative directories
+        # is package-specific. The default implementation interpret them
+        # as relative to the source directory, but packages like CMake will
+        # interpret them as relative to their build directories.
+        attr_accessor :doc_dir
+
+        # Directory in which the documentation target should install the
+        # documentation. If it is relative, it is interpreted as relative to
+        # the prefix directory.
+        attr_accessor :doc_target_dir
+
+        # Defines a documentation generation task. The documentation is first
+        # generated by the given block, and then installed. The local attribute
+        # #doc_dir defines where the documentation is generated by the
+        # package's build system, and the #doc_target_dir and
+        # Autobuild.doc_prefix attributes define where it should be installed.
+        #
+        # The block is invoked in the package's source directory
+        #
+        # In general, specific package types define a meaningful #with_doc
+        # method which calls this method internally.
+        def doc_task
+            task "#{name}-doc" => "#{name}-build" do
+                @installed_doc = false
+                catch(:doc_disabled) do
+                    Dir.chdir(srcdir) do
+                        yield if block_given?
+                    end
+
+                    unless @installed_doc
+                        install_doc
+                    end
+                end
+            end
+
+            task :doc => "#{name}-doc"
+        end
+
+        def install_doc(relative_to = srcdir)
+            full_doc_prefix = File.expand_path(Autobuild.doc_prefix, Autobuild.prefix)
+            doc_target_dir  = File.expand_path(self.doc_target_dir, full_doc_prefix)
+            doc_dir         = File.expand_path(self.doc_dir, relative_to)
+            FileUtils.rm_rf   doc_target_dir
+            FileUtils.mkdir_p File.dirname(doc_target_dir)
+            FileUtils.cp_r    doc_dir, doc_target_dir
+
+            @installed_doc = true
+        end
+
+        # Can be called in the doc_task implementation to announce that the
+        # documentation is to be disabled for that package. This is mainly used
+        # when a runtime check is necessary to know if a package has
+        # documentation or not.
+        def doc_disabled
+            throw :doc_disabled
+        end
+
+        # True if a documentation task is defined for this package
+        def has_doc?
+            !!Rake.application.lookup("#{name}-doc")
+        end
+
 	def post_install(*args, &block)
 	    if args.empty?
 		@post_install = block
@@ -130,7 +199,6 @@ module Autobuild
 		task "#{p}-import" => "#{name}-import"
 		task "#{p}-prepare" => "#{name}-prepare"
 		task "#{p}-build" => "#{name}-build"
-		task "#{p}-install" => "#{name}-install"
 		@provides << p
 	    end
 	end

data/lib/autobuild/packages/cmake.rb

@@ -31,6 +31,20 @@ module Autobuild
             @defines[name] = value
         end
 
+        def install_doc
+            super(builddir)
+        end
+
+        # Declare that the given target can be used to generate documentation
+        def with_doc(target = 'doc')
+            doc_task do
+                Dir.chdir(builddir) do
+                    Subprocess.run(name, 'doc', Autobuild.tool(:make), target)
+                    yield if block_given?
+                end
+            end
+        end
+
         def prepare
             super
 
@@ -68,7 +82,7 @@ module Autobuild
                 command << srcdir
                 
                 Subprocess.run(name, 'configure', *command)
-                touch_stamp configurestamp
+                super
             end
         end
 
@@ -88,7 +102,7 @@ module Autobuild
             Dir.chdir(builddir) do
                 Subprocess.run(name, 'install', Autobuild.tool(:make), 'install')
             end
-            touch_stamp(installstamp)
+            super
         end
     end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: autobuild
 version: !ruby/object:Gem::Version 
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors: 
 - Sylvain Joyeux
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-09 00:00:00 +02:00
+date: 2008-10-14 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency