autoproj 1.5.4 → 1.5.5

data/History.txt

@@ -1,3 +1,30 @@
+= Version 1.5.5
+ * allow to exclude some packages on some architectures
+
+   Autobuild files can now contain 
+     not_on 'os_name1', 'os_name2' do
+       ...
+     end
+   statements that will exclude any package defined in
+   the do ... end block if the OS is listed in the OS
+   names
+
+   os_name is either a plain string, in which case it has to be the main
+   operating system name (e.g. 'unbuntu', 'debian', ...) or a [name, version]
+   array.
+
+   For instance:
+
+     not_on 'ubuntu', ['debian', 'squeeze'] do
+       cmake_package 'not_on_ubuntu_and_debian_testing'
+     end
+
+   If the user tries to build one of the disabled packages, he will get a proper
+   error message.
+
+ * Debian unstable is now recognized by 'sid' and/or 'unstable'. It previously
+   had to be called 'squeeze/sid' (for the current unstable)
+
 = Version 1.5.4
  * better error message when a dependency does not exist
 

data/doc/guide/src/autoproj_bootstrap

@@ -140,7 +140,17 @@ module Autoproj
             end
         end
 
-        def operating_system
+        # Autodetects the operating system name and version
+        #
+        # +osname+ is the operating system name, all in lowercase (e.g. ubuntu,
+        # arch, gentoo, debian)
+        #
+        # +versions+ is a set of names that describe the OS version. It includes
+        # both the version number (as a string) and/or the codename if there is
+        # one.
+        #
+        # Examples: ['debian', ['sid', 'unstable']] or ['ubuntu', ['lucid lynx', '10.04']]
+        def self.operating_system
             if @operating_system
                 return @operating_system
             elsif data = os_from_lsb
@@ -155,17 +165,18 @@ module Autoproj
                 # Need to do some heuristics unfortunately
                 @operating_system =
                     if File.exists?('/etc/debian_version')
-                        codename = File.read('/etc/debian_version').strip
-                        ['debian', [codename]]
+                        codename = [File.read('/etc/debian_version').strip]
+                        if codename.first =~ /sid/
+                            codename << "unstable" << "sid"
+                        end
+                        ['debian', codename]
                     elsif File.exists?('/etc/gentoo-release')
                         release_string = File.read('/etc/gentoo-release').strip
                         release_string =~ /^.*([^\s]+)$/
                             version = $1
                         ['gentoo', [version]]
                     elsif File.exists?('/etc/arch-release')
-                        codename = "Unknown"
-                        puts "Found Arch"
-                        ['arch', [codename]]
+                        ['arch', []]
                     else
                         raise ConfigError, "Unknown operating system"
                     end
@@ -177,7 +188,7 @@ module Autoproj
                  @operating_system[1].map(&:downcase)]
         end
 
-        def os_from_lsb
+        def self.os_from_lsb
             has_lsb_release = `which lsb_release`
             return unless $?.success?
 
@@ -209,7 +220,7 @@ module Autoproj
         #
         # Raises ConfigError if some packages can't be found
         def resolve_os_dependencies(dependencies)
-            os_name, os_version = operating_system
+            os_name, os_version = OSDependencies.operating_system
             if !OS_PACKAGE_INSTALL.has_key?(os_name)
                 raise ConfigError, "I don't know how to install packages on #{os_name}"
             end

data/doc/guide/src/customization.page

@@ -61,7 +61,7 @@ line, instead of package names:
 autoproj build lib
 {: .commandline}
 
-Removing packages from the build
+Removing packages from the build (<tt>exclude_packages</tt>) {#exclude_packages}
 --------------------------------
 Instead of having to list all packages that you do want to build, it is possible
 to list the packages that you don't want to build. Simply list them in the
@@ -76,7 +76,10 @@ exclude_packages:
   - pocosim-log
 {coderay}
 
-Using packages that are already installed
+If another package, that should be built, depends on an excluded package, [an
+error is generated](error_messages.html#exclusions)
+
+Using packages that are already installed (<tt>ignore_packages</tt>) 
 -----------------------------------------
 
 If some packages are already installed elsewhere, and you want to use that
@@ -95,10 +98,10 @@ ignore_packages:
   - orocos/rtt
 {coderay}
 
-This differs from the <tt>exclude_packages</tt> mechanism: packages listed in
-<tt>ignore_packages</tt> are assumed to be present even though autoproj does not manage
-them, while packages in <tt>exclude_packages</tt> are assumed to be absent and therefore
-issue an error if another package in the installation depend on them.
+Unlike with <tt>exclude_packages</tt>, no error is generated for ignored
+packages that are depended-upon by other packages in the build. This is because
+ignore_packages is meant to list packages that are already installed outside of
+autoproj, while exclude_packages lists what you do **not** want to have at all.
 
 Local overrides of version control information
 ----------------------------------------------

data/doc/guide/src/error_messages.page

@@ -1,6 +1,6 @@
 ---
 title: Understanding autoproj error messages
-sort_info: 800
+sort_info: 90
 ---
 
 I know nothing about a prepackaged package called 'XXXX', ...
@@ -15,3 +15,23 @@ manifest.xml](package_sets/manifest-xml.html) file. (ii)
 the package should depend on it and you should list the OS package in [the
 relevant osdeps file](package_sets/osdeps.html)
 
+XXX depends on YYY, which is excluded from the build {#exclusions}
+----------------------------------------------------
+
+The layout requires the XXX package to be built, but this package depends on YYY
+and YYY has explicitely been excluded from the build.
+
+There are two cases.
+
+In the first case, the package has been listed in [the exclude_packages section
+of autoproj/manifest](customization.html#exclude_packages). So, you will have to
+find out why and either remove it from there, or add XXX to the same section.
+
+In the second case, the package is disabled on your operating system version.
+This is done in the package set's autobuild files by using the [not_on and
+only_on statements](package_sets/autobuild.html#not_on_and_only_on). You will
+have to either exclude the XXX package as well (either by including it in the
+same not_on/only_on block, or by adding it to [the exclude_packages section
+of autoproj/manifest](customization.html#exclude_packages)), or to make it so
+that YYY builds on your OS, an thus remove it from the not_on/only_on block.
+

data/doc/guide/src/package_sets/autobuild.page

@@ -112,6 +112,44 @@ The 'pkg' variable in the example above is an instance of
 [Autobuild::Orogen](http://doudou.github.com/autobuild/Autobuild/Orogen.html)
 {: .block}
 
+OS-specific bits (<tt>not_on</tt> and <tt>only_on</tt>) {#not_on_and_only_on}
+----------------
+It is possible to have some parts of the autobuild file be OS-specific. Two
+calls are made available for that.
+
+First, if you know that some packages should not be built on some operating
+systems, you should enclose their declaration in a 'not_on' statement. For
+instance:
+
+{coderay:: ruby}
+not_on 'debian' do
+  cmake_package 'excluded_package'
+end
+{coderay}
+
+It is additionally possible to select specific versions
+
+{coderay:: ruby}
+not_on 'debian', ['ubuntu', '10.04'] do
+  cmake_package 'excluded_package'
+end
+{coderay}
+
+If, on the other hand, you want some bits to be available only **on** a specific
+OS, use the only_on statement:
+
+{coderay:: ruby}
+only_on ['ubuntu', '10.04'] do
+  cmake_package 'only_ubuntu'
+end
+{coderay}
+
+If the user tries to build a package that is excluded on his architecture, he
+will get the following error message:
+
+modules/dynamixel depends on drivers/dynamixel, which is excluded from the build: drivers/dynamixel is disabled on this operating system
+{: .cmdline}
+
 Custom package building
 -----------------------
 

data/lib/autoproj/autobuild.rb

@@ -312,6 +312,41 @@ def orogen_package(options, &block)
     end
 end
 
+# Declare that the packages declared in the block should not be built in the
+# given operating system. OS descriptions are space-separated strings containing
+# OS name and version.
+#
+# An error will occur if the user tries to build it on one of those
+# architectures
+def not_on(*architectures)
+    architectures = architectures.map do |name|
+        if name.respond_to?(:to_str)
+            [name]
+        else name
+        end
+    end
+
+    os = OSDependencies.operating_system
+    matching_archs = architectures.find_all { |arch| arch[0] == os[0] }
+    STDERR.puts matching_archs.inspect
+    if matching_archs.empty?
+        return yield
+    elsif matching_archs.all? { |arch| arch[1] && !os[1].include?(arch[1].downcase) }
+        return yield
+    end
+
+    # Simply get the current list of packages, yield the block, and exclude all
+    # packages that have been added
+    current_packages = Autobuild::Package.each(true).map(&:last).map(&:name).to_set
+    yield
+    new_packages = Autobuild::Package.each(true).map(&:last).map(&:name).to_set -
+        current_packages
+
+    new_packages.each do |pkg_name|
+        Autoproj.manifest.add_exclusion(pkg_name, "#{pkg_name} is disabled on this operating system")
+    end
+end
+
 # Defines an import-only package, i.e. a package that is simply checked out but
 # not built in any way
 def source_package(options)

data/lib/autoproj/cmdline.rb

@@ -304,8 +304,8 @@ module Autoproj
                     # them to the selected_packages set so that they get
                     # imported as well
                     pkg.dependencies.each do |dep_name|
-                        if Autoproj.manifest.excluded?(dep_name)
-                            raise ConfigError, "#{pkg.name} depends on #{dep_name}, which is explicitely excluded in the manifest"
+                        if reason = Autoproj.manifest.exclusion_reason(dep_name)
+                            raise ConfigError, "#{pkg.name} depends on #{dep_name}, which is excluded from the build: #{reason}"
                         end
                         dep_pkg = Autobuild::Package[dep_name]
                         if !dep_pkg
@@ -440,6 +440,15 @@ where 'mode' is one of:
                 opts.on("--[no-]update", "[do not] update already checked-out packages (build modes only)") do |value|
                     do_update = value
                 end
+                opts.on("--os", "displays the operating system as detected by autoproj") do
+                    os = OSDependencies.operating_system
+                    puts "name: #{os[0]}"
+                    puts "version:"
+                    os[1].each do |version_name|
+                        puts "  #{version_name}"
+                    end
+                    exit 0
+                end
 
                 opts.on("--[no-]osdeps", "[do not] install prepackaged dependencies (build and update modes only)") do |value|
                     update_os_dependencies = value

data/lib/autoproj/manifest.rb

@@ -204,6 +204,13 @@ module Autoproj
                 !File.exists?(File.join(raw_local_dir, "init.rb"))
         end
 
+        # Remote sources can be accessed through a hidden directory in
+        # $AUTOPROJ_ROOT/.remotes, or through a symbolic link in
+        # autoproj/remotes/
+        #
+        # This returns the former. See #user_local_dir for the latter.
+        #
+        # For local sources, is simply returns the path to the source directory.
         def raw_local_dir
             if local?
                 return vcs.url 
@@ -212,6 +219,13 @@ module Autoproj
             end
         end
 
+        # Remote sources can be accessed through a hidden directory in
+        # $AUTOPROJ_ROOT/.remotes, or through a symbolic link in
+        # autoproj/remotes/
+        #
+        # This returns the latter. See #raw_local_dir for the former.
+        #
+        # For local sources, is simply returns the path to the source directory.
         def user_local_dir
             if local?
                 return vcs.url 
@@ -247,6 +261,10 @@ module Autoproj
             end
         end
 
+        # Loads the source.yml file, validates it and returns it as a hash
+        #
+        # Raises InternalError if the source has not been checked out yet (it
+        # should have), and ConfigError if the source.yml file is not valid.
         def raw_description_file
             if !present?
                 raise InternalError, "source #{vcs} has not been fetched yet, cannot load description for it"
@@ -284,6 +302,7 @@ module Autoproj
         rescue InternalError
         end
 
+        # Path to the source.yml file
         def source_file
             File.join(local_dir, 'source.yml')
         end
@@ -357,7 +376,8 @@ module Autoproj
             data
         end
 
-        # Returns the default importer for this package set
+        # Returns the default importer definition for this package set, as a
+        # VCSDefinition instance
         def default_importer
             importer_definition_for('default')
         end
@@ -452,13 +472,19 @@ module Autoproj
             raise ConfigError, "#{e.message} in #{source_file}", e.backtrace
         end
 
+        # Returns the VCS definition for +package_name+ as defined in this
+        # source, or nil if the source does not have any.
+        #
+        # The definition is an instance of VCSDefinition
         def importer_definition_for(package_name)
-            vcs_spec = version_control_field(package_name, 'version_control_field')
+            vcs_spec = version_control_field(package_name, 'version_control')
             if vcs_spec
                 Autoproj.normalize_vcs_definition(vcs_spec)
             end
         end
 
+        # Enumerates the Autobuild::Package instances that are defined in this
+        # source
         def each_package
             if !block_given?
                 return enum_for(:each_package)
@@ -472,6 +498,7 @@ module Autoproj
         end
     end
 
+    # Specialization of the Source class for the overrides listed in autoproj/
     class LocalSource < Source
         def initialize
             super(Autoproj.normalize_vcs_definition(:type => 'local', :url => Autoproj.config_dir))
@@ -511,8 +538,16 @@ module Autoproj
 
     PackageDefinition = Struct.new :autobuild, :user_block, :package_set, :file
 
+    # The Manifest class represents the information included in the main
+    # manifest file, and allows to manipulate it
     class Manifest
         FakePackage = Struct.new :text_name, :name, :srcdir, :importer, :updated
+
+        # Data structure used to use autobuild importers without a package, to
+        # import configuration data.
+        #
+        # It has to match the interface of Autobuild::Package that is relevant
+        # for importers
         class FakePackage
             def autoproj_name; name end
             def import
@@ -543,6 +578,8 @@ module Autoproj
             explicit_selection && explicit_selection.include?(pkg_name)
         end
 
+        # Loads the manifest file located at +file+ and returns the Manifest
+        # instance that represents it
 	def self.load(file)
             begin
                 data = YAML.load(File.read(file))
@@ -564,8 +601,11 @@ module Autoproj
         # A mapping from package names into PackageManifest objects
         attr_reader :package_manifests
 
+        # The path to the manifest file that has been loaded
         attr_reader :file
 
+        # True if autoproj should run an update automatically when the user
+        # uses" build"
         def auto_update?
             !!data['auto_update']
         end
@@ -575,6 +615,7 @@ module Autoproj
 	    @data = data
             @packages = Hash.new
             @package_manifests = Hash.new
+            @automatic_exclusions = Hash.new
 
             if Autoproj.has_config_key?('manifest_source')
                 @vcs = Autoproj.normalize_vcs_definition(Autoproj.user_config('manifest_source'))
@@ -592,14 +633,47 @@ module Autoproj
                 false
             end
         end
+
+        # The set of package names that are listed in the excluded_packages
+        # section of the manifest
+        def manifest_exclusions
+            data['exclude_packages'] || Set.new
+        end
+
+        # A package_name => reason map of the exclusions added with #add_exclusion.
+        # Exclusions listed in the manifest file are returned by #manifest_exclusions
+        attr_reader :automatic_exclusions
+
+        # Exclude +package_name+ from the build. +reason+ is a string describing
+        # why the package is to be excluded.
+        def add_exclusion(package_name, reason)
+            automatic_exclusions[package_name] = reason
+        end
+
+        # If +package_name+ is excluded from the build, returns a string that
+        # tells why. Otherwise, returns nil
+        #
+        # Packages can either be excluded because their name is listed in the
+        # excluded_packages section of the manifest, or because they are
+        # disabled on this particular operating system.
+        def exclusion_reason(package_name)
+            if manifest_exclusions.any? { |l| Regexp.new(l) =~ package_name }
+                "#{package_name} is listed in the excluded_packages section of the manifest"
+            else
+                automatic_exclusions[package_name]
+            end
+        end
+
         # True if the given package should not be built and its dependencies
         # should be considered as met.
         #
         # This is useful to avoid building packages that are of no use for the
         # user.
         def excluded?(package_name)
-            if data['exclude_packages']
-                data['exclude_packages'].any? { |l| Regexp.new(l) =~ package_name }
+            if manifest_exclusions.any? { |l| Regexp.new(l) =~ package_name }
+                true
+            elsif automatic_exclusions.any? { |pkg_name, | pkg_name == package_name }
+                true
             else
                 false
             end
@@ -631,6 +705,7 @@ module Autoproj
             end
 	end
 
+        # Yields each osdeps definition files that are present in our sources
         def each_osdeps_file
             if !block_given?
                 return enum_for(:each_source_file)
@@ -643,6 +718,7 @@ module Autoproj
             end
         end
 
+        # True if some of the sources are remote sources
         def has_remote_sources?
             each_remote_source(false).any? { true }
         end

data/lib/autoproj/osdeps.rb

@@ -73,7 +73,17 @@ module Autoproj
             end
         end
 
-        def operating_system
+        # Autodetects the operating system name and version
+        #
+        # +osname+ is the operating system name, all in lowercase (e.g. ubuntu,
+        # arch, gentoo, debian)
+        #
+        # +versions+ is a set of names that describe the OS version. It includes
+        # both the version number (as a string) and/or the codename if there is
+        # one.
+        #
+        # Examples: ['debian', ['sid', 'unstable']] or ['ubuntu', ['lucid lynx', '10.04']]
+        def self.operating_system
             if @operating_system
                 return @operating_system
             elsif data = os_from_lsb
@@ -88,17 +98,18 @@ module Autoproj
                 # Need to do some heuristics unfortunately
                 @operating_system =
                     if File.exists?('/etc/debian_version')
-                        codename = File.read('/etc/debian_version').strip
-                        ['debian', [codename]]
+                        codename = [File.read('/etc/debian_version').strip]
+                        if codename.first =~ /sid/
+                            codename << "unstable" << "sid"
+                        end
+                        ['debian', codename]
                     elsif File.exists?('/etc/gentoo-release')
                         release_string = File.read('/etc/gentoo-release').strip
                         release_string =~ /^.*([^\s]+)$/
                             version = $1
                         ['gentoo', [version]]
                     elsif File.exists?('/etc/arch-release')
-                        codename = "Unknown"
-                        puts "Found Arch"
-                        ['arch', [codename]]
+                        ['arch', []]
                     else
                         raise ConfigError, "Unknown operating system"
                     end
@@ -110,7 +121,7 @@ module Autoproj
                  @operating_system[1].map(&:downcase)]
         end
 
-        def os_from_lsb
+        def self.os_from_lsb
             has_lsb_release = `which lsb_release`
             return unless $?.success?
 
@@ -142,7 +153,7 @@ module Autoproj
         #
         # Raises ConfigError if some packages can't be found
         def resolve_os_dependencies(dependencies)
-            os_name, os_version = operating_system
+            os_name, os_version = OSDependencies.operating_system
             if !OS_PACKAGE_INSTALL.has_key?(os_name)
                 raise ConfigError, "I don't know how to install packages on #{os_name}"
             end

data/lib/autoproj/version.rb

@@ -1,3 +1,3 @@
 module Autoproj
-    VERSION = "1.5.4"
+    VERSION = "1.5.5"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 5
-  - 4
-  version: 1.5.4
+  - 5
+  version: 1.5.5
 platform: ruby
 authors: 
 - Sylvain Joyeux
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-15 00:00:00 +02:00
+date: 2010-06-16 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency