autoproj 1.3.4 → 1.4.0

data/History.txt

@@ -1,3 +1,14 @@
+= Version 1.4.0
+ * ruby 1.9 compatible
+ * fixes w.r.t. running autoproj under a Ruby interpreter that is not called
+   'ruby' (as ruby1.9.1 on Debian)
+ * packages that os-depend on 'ruby' will now depend on either ruby18 or ruby19,
+   depending on the ruby version used.
+ * add Arch-Linux support
+ * fixes w.r.t. the 'doc' mode. In particular, the documentation installation
+   now follows the layout.
+ * some cosmetic fixes
+
 = Version 1.3.4
  * Improve the RubyGems support
    - a given osdeps name can refer to a mixture of RubyGems and OS packages

data/Manifest.txt

@@ -7,7 +7,6 @@ doc/guide/config.yaml
 doc/guide/ext/init.rb
 doc/guide/ext/previous_next.rb
 doc/guide/ext/rdoc_links.rb
-doc/guide/src/autobuild.page
 doc/guide/src/autoproj_bootstrap
 doc/guide/src/customization.page
 doc/guide/src/default.css
@@ -21,7 +20,12 @@ doc/guide/src/images/footerbg.png
 doc/guide/src/images/gradient1.png
 doc/guide/src/images/gradient2.png
 doc/guide/src/index.page
-doc/guide/src/source_yml.page
+doc/guide/src/manifest.xml
+doc/guide/src/package_sets/autobuild.page
+doc/guide/src/package_sets/importers.page
+doc/guide/src/package_sets/index.page
+doc/guide/src/package_sets/manifest-xml.page
+doc/guide/src/package_sets/osdeps.page
 doc/guide/src/structure.page
 lib/autoproj.rb
 lib/autoproj/autobuild.rb

data/README.txt

@@ -28,20 +28,22 @@ specification. More specifically, the package manifest files are common between
 ROS package management and autoproj (more details in the following of this
 document).
 
-Components of an Autoproj installation
+Overview of an autoproj installation
 -------------------------------------
-A autoproj installation is seeded by _package sets_. A package set is a local or remote
-directory in which there is:
 
- * a list of available packages, and information on how to build these packages.
-   This list, and the build information, are Ruby scripts that use the autobuild
-   API. [More ...](autobuild.html)
- * version control information: where to get the source code for each of the
-   packages defined in the set.
+The idea in an autoproj installation is that people share _definitions_ for a
+set of packages that can depend on each other. Then, anyone can cherry-pick in
+these definitions to build its own installation (in practice, one builds a
+complete configuration per-project).
 
-Then, an autoproj configuration is simply a list of package sets (i.e. a list of
-packages that are available to build), and a file that selects which packages
-should be built. This file is the <tt>manifest</tt>.
+Each package definition includes:
+
+ * how to get the package's source code
+ * how to build the package
+ * on what the package depends. This can be either another package built by
+   autoproj, or an operating system package.
+
+See [this page](structure.html) for more information.
 
 Bootstrapping
 -------------
@@ -97,6 +99,6 @@ As a guideline, we recommend that inter-package dependencies are managed by
 using pkg-config.
 
 To describe the package, and more importantly to setup cross-package
-dependencies, an optional manifest file can be added. This manifest file is
-named manifest.xml. Its format is described later in this user's guide.
+dependencies, [an optional manifest file can be
+added](package_sets/manifest-xml.html).
 

data/Rakefile

@@ -30,7 +30,7 @@ begin
             if !system('doc/update_github')
                 raise "cannot update the gh-pages branch for GitHub"
             end
-            if !system('git', 'push', 'origin', 'gh-pages')
+            if !system('git', 'push', 'origin', '+gh-pages')
                 raise "cannot push the documentation"
             end
         end

data/bin/autoproj

@@ -81,6 +81,7 @@ Additional options:
         Autobuild.verbose = true
         Rake.application.options.trace = true
         debug = true
+        Autobuild.debug = true
     end
     opts.on('--nice NICE', Integer, 'nice the subprocesses to the given value') do |value|
         Autobuild.nice = value
@@ -126,12 +127,8 @@ def display_status(packages)
         lines = []
 
         if !pkg.importer.respond_to?(:status)
-            # This importer does not support status display
-            STDERR.puts color("  the importer of #{pkg.autoproj_name} does not support status display (#{pkg.importer.class.name})", :bold, :red)
-            next
-        end
-
-        if !File.directory?(pkg.srcdir)
+            lines << color("  the #{pkg.importer.class.name.gsub(/.*::/, '')} importer does not support status display", :bold, :red)
+        elsif !File.directory?(pkg.srcdir)
             lines << color("  is not imported yet", :magenta)
         else
             status = pkg.importer.status(pkg)
@@ -305,7 +302,10 @@ def do_bootstrap(*args)
         STDERR.puts "autoproj: reusing bootstrap from #{File.dirname(ENV['GEM_HOME'])}"
         FileUtils.cp_r ENV['GEM_HOME'], ".gems"
         ENV['GEM_HOME'] = File.join(Dir.pwd, ".gems")
-        exec $0, *ARGV
+
+        require 'rbconfig'
+        ruby = RbConfig::CONFIG['RUBY_INSTALL_NAME']
+        exec ruby, $0, *ARGV
     end
 
     # If we are not getting the installation setup from a VCS, copy the template
@@ -377,6 +377,8 @@ end
 Autobuild.doc_errors = false
 Autobuild.do_doc = false
 
+Autoproj::OSDependencies.autodetect_ruby
+
 # Find the autoproj root dir
 report(debug) do
     case mode
@@ -421,6 +423,7 @@ report(debug) do
         end
     when "doc"
         Autobuild.do_update = false
+        no_os_deps          = true
         Autobuild.do_doc    = true
         Autobuild.only_doc  = true
     else
@@ -464,7 +467,13 @@ report(debug) do
     osdeps = Autoproj::OSDependencies.load_default
     if osdeps.install(%w{autobuild autoproj})
         # We updated autobuild or autoproj themselves ... Restart !
-        exec($0, *ARGV)
+        require 'rbconfig'
+        ruby = RbConfig::CONFIG['RUBY_INSTALL_NAME']
+	if mode == "bootstrap"
+	    exec(ruby, $0, 'list-sets')
+	else
+            exec(ruby, $0, *ARGV)
+	end
     end
 
     manifest_path = File.join(Autoproj.config_dir, 'manifest')
@@ -623,6 +632,7 @@ report(debug) do
             pkg = Autobuild::Package[pkg_name]
             pkg.srcdir = File.join(srcdir, pkg_name)
             pkg.prefix = prefix
+            pkg.doc_target_dir = File.join(Autoproj.build_dir, 'doc', name, pkg_name)
             pkg.logdir = logdir
         end
         seen |= packages

data/doc/guide/ext/init.rb

@@ -11,6 +11,7 @@ config = Webgen::WebsiteAccess.website.config
 
 config = Webgen::WebsiteAccess.website.config
 config['sourcehandler.patterns']['Webgen::SourceHandler::Copy'] << '**/autoproj_bootstrap'
+config['sourcehandler.patterns']['Webgen::SourceHandler::Copy'] << '**/manifest.xml'
 
 $LOAD_PATH.unshift File.expand_path('..', File.dirname(__FILE__))
 require 'ext/rdoc_links'

data/doc/guide/src/autoproj_bootstrap

@@ -5,18 +5,23 @@ if RUBY_VERSION < "1.8.7"
     exit 1
 end
 
-ENV['GEM_HOME'] = "#{Dir.pwd}/.gems"
-ENV['PATH']     = "#{ENV['GEM_HOME']}/bin:#{ENV['PATH']}"
+needed_gem_home = "#{Dir.pwd}/.gems"
 if $LOADED_FEATURES.find { |str| str =~ /bygems/ }
-    ENV['RUBYOPT']  = ""
-    exec "ruby", __FILE__, *ARGV
+    if ENV['GEM_HOME'] != needed_gem_home
+        require 'rbconfig'
+        RUBY = RbConfig::CONFIG['RUBY_INSTALL_NAME']
+
+        ENV['GEM_HOME'] = needed_gem_home
+        exec RUBY, __FILE__, *ARGV
+    end
 end
 
-ENV['RUBYOPT']  = "-rubygems"
+
+ENV['GEM_HOME'] = needed_gem_home
+ENV['PATH']     = "#{ENV['GEM_HOME']}/bin:#{ENV['PATH']}"
 
 require 'yaml'
 require 'set'
-require 'rubygems'
 
 module Autoproj
     class ConfigError < RuntimeError; end
@@ -32,6 +37,22 @@ module Autobuild
     def self.progress(str)
         STDERR.puts "  #{str}"
     end
+
+    class << self
+        attr_reader :programs
+    end
+    @programs = Hash.new
+    def self.tool(name)
+        # Let the ability to set programs[name] to nil to make sure we don't use
+        # that program. This is used later on in this file to make sure we
+        # aren't using the wrong rubygems binary
+        if programs.has_key?(name)
+            programs[name]
+        else
+            name
+        end
+    end
+
     module Subprocess
         def self.run(name, phase, *cmd)
             output = `#{cmd.join(" ")}`
@@ -57,16 +78,36 @@ module Autoproj
 
             OSDependencies.new(data)
         end
+
+        class << self
+            attr_reader :aliases
+        end
+        @aliases = Hash.new
+
+        def self.alias(old_name, new_name)
+            @aliases[new_name] = old_name
+        end
+
+        def self.autodetect_ruby
+            ruby_package =
+                if RUBY_VERSION < "1.9.0" then "ruby18"
+                else "ruby19"
+                end
+            self.alias(ruby_package, "ruby")
+        end
+
         AUTOPROJ_OSDEPS = File.join(File.expand_path(File.dirname(__FILE__)), 'default.osdeps')
         def self.load_default
             @default_osdeps ||= OSDependencies.load(AUTOPROJ_OSDEPS)
         end
 
         attr_reader :definitions
-        attr_reader :gem_fetcher
+        def gem_fetcher
+            @gem_fetcher ||= Gem::SpecFetcher.fetcher
+        end
+
         def initialize(defs = Hash.new)
             @definitions = defs.to_hash
-            @gem_fetcher = Gem::SpecFetcher.fetcher
         end
 
         def merge(info)
@@ -95,6 +136,10 @@ module Autoproj
                         release_string =~ /^.*([^\s]+)$/
                             version = $1
                         ['gentoo', [version]]
+                    elsif File.exists?('/etc/arch-release')
+                        codename = "Unknown"
+                        puts "Found Arch"
+                        ['arch', [codename]]
                     else
                         raise ConfigError, "Unknown operating system"
                     end
@@ -129,7 +174,8 @@ module Autoproj
         OS_PACKAGE_INSTALL = {
             'debian' => 'apt-get install -y %s',
             'ubuntu' => 'apt-get install -y %s',
-            'gentoo' => 'emerge --noreplace %s'
+            'gentoo' => 'emerge --noreplace %s',
+            'arch' => 'pacman -Sy --noconfirm %s'
         }
 
         def generate_os_script(dependencies)
@@ -192,7 +238,7 @@ module Autoproj
         # call-seq:
         #   partition_packages(package_names) => os_packages, gem_packages
         def partition_packages(package_set, package_osdeps = Hash.new)
-            package_set = package_set.to_set
+            package_set = package_set.map { |name| OSDependencies.aliases[name] || name }.to_set
             osdeps, gems = [], []
             package_set.to_set.each do |name|
                 pkg_def = definitions[name]
@@ -230,6 +276,19 @@ module Autoproj
             return osdeps, gems
         end
 
+        def guess_gem_program
+            if Autobuild.programs['gem']
+                return Autobuild.programs['gem']
+            end
+
+            ruby_bin = Config::CONFIG['RUBY_INSTALL_NAME']
+            if ruby_bin =~ /^ruby(.+)$/
+                Autobuild.programs['gem'] = "gem#{$1}"
+            else
+                Autobuild.programs['gem'] = "gem"
+            end
+        end
+
         # Requests the installation of the given set of packages
         def install(packages, package_osdeps = Hash.new)
             osdeps, gems = partition_packages(packages, package_osdeps)
@@ -269,7 +328,7 @@ module Autoproj
                     if !installed.empty? && Autobuild.do_update
                         # Look if we can update the package ...
                         dep = Gem::Dependency.new(name, version_requirements)
-                        available = @gem_fetcher.find_matching(dep)
+                        available = gem_fetcher.find_matching(dep)
                         installed_version = installed.map(&:version).max
                         available_version = available.map { |(name, v), source| v }.max
                         needs_update = (available_version > installed_version)
@@ -282,12 +341,14 @@ module Autoproj
 
             # Now install what is left
             if !gems.empty?
+                guess_gem_program
+
                 if Autoproj.verbose
                     STDERR.puts "Installing rubygems dependencies with"
                     STDERR.puts "gem install #{gems.join(" ")}"
                 end
                 Autobuild.progress "installing/updating RubyGems dependencies: #{gems.join(", ")}"
-                Autobuild::Subprocess.run 'autoproj', 'osdeps', 'gem', 'install', *gems
+                Autobuild::Subprocess.run 'autoproj', 'osdeps', Autobuild.tool('gem'), 'install', *gems
                 did_something ||= true
             end
 
@@ -302,24 +363,44 @@ DEFS = <<EODEFS
 # The following definitions are needed to bootstrap autoproj
 none: ignore
 
-ruby:
+ruby18:
     debian,ubuntu:
         - ruby1.8-dev
         - ruby1.8
+        - rubygems1.8
+        - ri1.8
         - libopenssl-ruby1.8
     gentoo:
         - dev-lang/ruby:1.8
 
+ruby19:
+    debian,ubuntu:
+        - ruby1.9.1
+        - ruby1.9.1-dev
+        - rubygems1.9.1
+        - ri1.9.1
+        - libopenssl-ruby1.9.1
+    gentoo:
+        - dev-lang/ruby:1.9
+    arch:
+        - ruby
+
+rdoc: gem
+
 build-essential:
     debian,ubuntu: build-essential
     gentoo:
+    arch:
 
 libxml2:
     debian,ubuntu: libxml2-dev
     gentoo: dev-libs/libxml2
+    arch: libxml2
+
 libxslt:
     debian,ubuntu: libxslt1-dev
     gentoo: dev-libs/libxslt
+    arch: libxslt
 
 autobuild: gem
 autoproj: gem
@@ -328,35 +409,58 @@ autoproj: gem
 git:
     debian,ubuntu: git-core
     gentoo: dev-util/git
-
+    arch: git
 svn:
     debian,ubuntu: subversion
     gentoo: dev-util/subversion
-
+    arch: subversion
 cmake:
     debian,ubuntu: cmake
     gentoo: dev-util/cmake
+    arch: cmake
 
 autotools:
     debian,ubuntu: [automake1.9, autoconf]
     gentoo: [sys-devel/automake:1.9, sys-devel/autoconf]
+    arch: automake autoconf
 
 lsb_release:
     debian,ubuntu: lsb-release
     gentoo: sys-apps/lsb-release
+    arch:
     
 archive:
     debian,ubuntu: [tar, unzip]
     gentoo: [app-arch/tar, app-arch/unzip]
+    arch: [tar, unzip]
 
 # vim: expandtab
 
 
 EODEFS
 
-PACKAGES      = %w{ruby libxml2 libxslt build-essential lsb_release}
+# First thing we do is install a proper ruby environment. We make sure that we
+# aren't installing any gems for now (as we need to choose the right gem
+# binary) by setting Autobuild.programs['gem'] to nil
+Autobuild.programs['gem'] = nil
+Autoproj::OSDependencies.autodetect_ruby
+
+begin
+    osdeps_management = Autoproj::OSDependencies.new(YAML.load(DEFS))
+    STDERR.puts "autoproj: installing a proper Ruby environment (this can take a long time)"
+    osdeps_management.install(['ruby'])
+rescue Autoproj::ConfigError => e
+    STDERR.puts "failed: #{e.message}"
+    exit(1)
+end
+
+# Now try to find out the name of the gem binary
+PACKAGES      = %w{rdoc libxml2 libxslt build-essential lsb_release}
 USER_PACKAGES = %w{autoproj}
 
+ENV['RUBYOPT']  = "-rubygems"
+require 'rubygems'
+
 packages = PACKAGES.dup
 if ARGV.first != "dev"
     packages += USER_PACKAGES

data/doc/guide/src/customization.page

@@ -105,7 +105,7 @@ Local overrides of version control information
 
 The <tt>autoproj/overrides.yml</tt> allows you to override version control information
 for specific packages. It has the same format than the source.yml file of
-package sets, so [check that page out](source_yml.html) for more information.
+package sets, so [check that page out](package_sets/importers.html) for more information.
 
 This file can in particular be used to avoid further updates to a given software
 package. Simply do: