autobuild 1.6.2.rc2 → 1.6.2.rc3

data/lib/autobuild/import/git.rb

@@ -203,7 +203,7 @@ module Autobuild
                     end
                 end
 
-                status = merge_status(remote_commit)
+                status = merge_status(package, remote_commit)
                 `git diff --quiet`
                 if $?.exitstatus != 0
                     status.uncommitted_code = true
@@ -279,7 +279,16 @@ module Autobuild
             end
         end
 
-        def merge_status(fetch_commit, reference_commit = "HEAD")
+        # Computes the update status to update a branch whose tip is at
+        # reference_commit (which can be a symbolic reference) using the
+        # fetch_commit commit
+        #
+        # I.e. this compute what happens if one would do
+        #
+        #   git checkout reference_commit
+        #   git merge fetch_commit
+        #
+        def merge_status(package, fetch_commit, reference_commit = "HEAD")
             common_commit = `git merge-base #{reference_commit} #{fetch_commit}`.chomp
             if $?.exitstatus != 0
                 raise PackageException.new(package, 'import'), "failed to find the merge-base between #{reference_commit} and #{fetch_commit}. Are you sure these commits exist ?"
@@ -314,12 +323,12 @@ module Autobuild
                 # If we are tracking a commit/tag, just check it out and return
                 if commit || tag
                     target_commit = (commit || tag)
-                    status_to_head = merge_status(target_commit, "HEAD")
+                    status_to_head = merge_status(package, target_commit, "HEAD")
                     if status_to_head.status == Status::UP_TO_DATE
                         # Check if by any chance we could switch back to a
                         # proper branch instead of having a detached HEAD
                         if detached_head?
-                            status_to_remote = merge_status(target_commit, fetch_commit)
+                            status_to_remote = merge_status(package, target_commit, fetch_commit)
                             if status_to_remote.status != Status::UP_TO_DATE
                                 package.message "  the package is on a detached HEAD because of commit pinning"
                                 return
@@ -331,11 +340,11 @@ module Autobuild
                         raise PackageException.new(package, 'import'), "checking out the specified commit #{target_commit} would be a non-simple operation (i.e. the current state of the repository is not a linear relationship with the specified commit), do it manually"
                     end
 
-                    status_to_remote = merge_status(target_commit, fetch_commit)
+                    status_to_remote = merge_status(package, target_commit, fetch_commit)
                     if status_to_remote.status != Status::UP_TO_DATE
                         # Try very hard to avoid creating a detached HEAD
                         if local_branch
-                            status_to_branch = merge_status(target_commit, local_branch)
+                            status_to_branch = merge_status(package, target_commit, local_branch)
                             if status_to_branch.status == Status::UP_TO_DATE # Checkout the branch
                                 package.message "  checking out specific commit %s for %s. It will checkout branch %s." % [target_commit.to_s, package.name, local_branch]
                                 Subprocess.run(package, :import, Autobuild.tool('git'), 'checkout', local_branch)
@@ -364,7 +373,7 @@ module Autobuild
                     end
                 end
 
-                status = merge_status(fetch_commit)
+                status = merge_status(package, fetch_commit)
                 if status.needs_update?
                     if !merge? && status.status == Status::NEEDS_MERGE
                         raise PackageException.new(package, 'import'), "the local branch '#{local_branch}' and the remote branch #{branch} of #{package.name} have diverged, and I therefore refuse to update automatically. Go into #{package.srcdir} and either reset the local branch or merge the remote changes"
@@ -395,7 +404,7 @@ module Autobuild
 
                 # If we are tracking a commit/tag, just check it out
                 if commit || tag
-                    status = merge_status(commit || tag)
+                    status = merge_status(package, commit || tag)
                     if status.status != Status::UP_TO_DATE
                         package.message "  checking out specific commit for %s. This will create a detached HEAD." % [package.name]
                         Subprocess.run(package, :import, Autobuild.tool('git'), 'checkout', commit || tag)

data/lib/autobuild/package.rb

@@ -101,7 +101,7 @@ module Autobuild
         # false.
         def updated?; !!@updated end
 
-	def initialize(spec)
+	def initialize(spec = Hash.new)
 	    @dependencies   = Array.new
 	    @provides       = Array.new
             @parallel_build_level = nil
@@ -374,27 +374,31 @@ module Autobuild
         # In general, specific package types define a meaningful #with_doc
         # method which calls this method internally.
         def doc_task
-            task "#{name}-doc" do
-                @installed_doc = false
-                catch(:doc_disabled) do
-                    begin
-                        yield if block_given?
-
-                        unless @installed_doc
-                            install_doc
-                        end
+            @doc_task = task "#{name}-doc" do
+                # This flag allows to disable documentation generation
+                # once doc_task has been called
+                if generates_doc?
+                    @installed_doc = false
+                    catch(:doc_disabled) do
+                        begin
+                            yield if block_given?
+
+                            unless @installed_doc
+                                install_doc
+                            end
 
-                    rescue Interrupt
-                        raise
-                    rescue ::Exception => e
-                        if Autobuild.doc_errors
+                        rescue Interrupt
                             raise
-                        else
-                            warn "%s: failed to generate documentation"
-                            if e.kind_of?(SubcommandFailed)
-                                warn "%s: see #{e.logfile} for more details"
+                        rescue ::Exception => e
+                            if Autobuild.doc_errors
+                                raise
                             else
-                                warn "%s: #{e.message}"
+                                warn "%s: failed to generate documentation"
+                                if e.kind_of?(SubcommandFailed)
+                                    warn "%s: see #{e.logfile} for more details"
+                                else
+                                    warn "%s: #{e.message}"
+                                end
                             end
                         end
                     end
@@ -404,6 +408,30 @@ module Autobuild
             task :doc => "#{name}-doc"
         end
 
+        # True if some documentation will be generated and false otherwise.
+        #
+        # This will return true only if a documentation task has been defined by
+        # calling #doc_task _and_ #disable_doc has not been called (or if
+        # #enable_doc has been called after the last call to #disable_doc).
+        def generates_doc?
+            if @doc_disabled
+                return false
+            else
+                return !!@doc_task
+            end
+        end
+
+        # Re-enables documentation generation after #disable_doc has been called
+        def enable_doc
+            @doc_disabled = false
+        end
+
+        # Disables any documentation generation, regardless of whether doc_task
+        # has been called or not.
+        def disable_doc
+            @doc_disabled = true
+        end
+
         def install_doc
             if !File.directory?(self.doc_dir)
                 raise "#{self.doc_dir} was expected to be a directory, but it is not. Check the package's documentation generation, the generated documentation should be in #{self.doc_dir}"

data/lib/autobuild/version.rb

@@ -1,5 +1,5 @@
 module Autobuild
-    VERSION = "1.6.2.rc2" unless defined? Autobuild::VERSION
+    VERSION = "1.6.2.rc3" unless defined? Autobuild::VERSION
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: autobuild
 version: !ruby/object:Gem::Version
-  version: 1.6.2.rc2
+  version: 1.6.2.rc3
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-17 00:00:00.000000000 Z
+date: 2012-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &18924760 !ruby/object:Gem::Requirement
+  requirement: &20141480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.7.0
   type: :runtime
   prerelease: false
-  version_requirements: *18924760
+  version_requirements: *20141480
 - !ruby/object:Gem::Dependency
   name: utilrb
-  requirement: &18535380 !ruby/object:Gem::Requirement
+  requirement: &20138420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.3.3
   type: :runtime
   prerelease: false
-  version_requirements: *18535380
+  version_requirements: *20138420
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &18534640 !ruby/object:Gem::Requirement
+  requirement: &20134680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *18534640
+  version_requirements: *20134680
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &18533880 !ruby/object:Gem::Requirement
+  requirement: &19452900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: '3.1'
   type: :development
   prerelease: false
-  version_requirements: *18533880
+  version_requirements: *19452900
 description: Collection of classes to handle build systems (CMake, autotools, ...)
   and import mechanisms (tarballs, CVS, SVN, git, ...). It also offers a Rake integration
   to import and build such software packages. It is the backbone of the autoproj (http://rock-robotics.org/autoproj)