builddir 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df6be8f636e1133b7097d050a8c73d260a382dd2
-  data.tar.gz: e929ac08a4cd490d001bfec6de33e584d44aa8a3
+  metadata.gz: 4d9161d3885f7096ee1c3a59a8ef96bdafb83d27
+  data.tar.gz: 647853ff7f8f2153d2a7d8289cd19d66fea09842
 SHA512:
-  metadata.gz: bf0f825e0ffdff8bde3c003bfed2dd35da72eebb1e4b2f2658e442ef95dc0223ae54402a1077cace34e0b73cc83ac231f8b46ce3e1716054db5f21f2c189dd37
-  data.tar.gz: 79f463b399bd840c17e37a094c9fb09facd93e89ad1e2d5cc164b2670680dadd766b113667da16b373c38cfef906e0d803fbb5cef56b5d6c212220f5865fe055
+  metadata.gz: 0ae988445fa2a8727c0d05c70fe01c40c025c3dd5435ab27446a2cd6239b9b9fbb1fced8ffa28ffb7de7f94c88fa995cdad314986c3fce44e2a71fe5e8cd4222
+  data.tar.gz: f65eb5155742b98c366a028b19adf63084ff9db3d9361eee932c478bea23fcf613769014b5dd2011eafefa6f7a0824f8600e2d0fc7ae027be2f4cac596caaa51

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.1.2 (2014-11-27)
+
+Features:
+
+  - extended the `builddir_cmake` helper with an option for toolchain files (`-A`)
+  - added some usage documentation to the README
+
 ## 0.1.1 (2014-08-05)
 
 Bugfixes:

data/README.md

@@ -1,9 +1,12 @@
-# Builddir
+# Builddir
 
 **builddir** is a little helper tool for C/C++ programmers to manage
 out-of-source build directories. It manages mappings between build directories
 and the associated source directories and allows to switch between them.
 
+The provided configure and cmake wrappers additionally ease the configuration
+by automatically specifying the path to the source directory.
+
 ## Installation
 
 Installation consists out of multiple steps. The first is to install the
@@ -12,8 +15,8 @@ builddir gem:
     gem install builddir
 
 Second, a shell wrapper script (`builddir_source_script`) has to be placed in
-the PATH. The script can either be installed by hand (from `lib/data`) or can
-be generated using the `builddir_generate_source_script` command.
+the PATH. The script can either be installed by hand (from `lib/builddir/data`)
+or can be generated using the `builddir_generate_source_script` command.
 
     builddir_generate_source_script ~/bin/builddir_source_script
 
@@ -39,9 +42,43 @@ variable definition to the configuration file
 
 ## Usage
 
-TODO: Document the different operations
+The following sections describe the most common operations briefly assuming
+that the recommended aliases have been configured.
+
+### Change to the build directory
+
+`cdb [baseName]` looks up the current directory as source directory and changes
+to the associated build directory. If no mapping could be found then a new one
+is created considering the optional basename.
+
+### Change to the source directory
+
+`cds` looks up the current directory as build directory and changes to the
+associated source directory. An error is returned if no mapping could be found.
+
+### Configuring inside of the build directory
+
+The configuration of an out-of-source build requires the path to the source
+directory. Wrapper scripts for the most common build systems are provided
+which automatically specify this path when needed. It is therefore possible
+to simply call `configure [options]` or `cmake [options]` in the build
+directory without any source path.
+
+#### cmake extension for toolchain files
+
+Cross compilation with cmake usually requires a toolchain file which is often
+distributed with the source code itself. Using such a file requires the
+specification of the full path which kind of defeats the purpose of the wrapper.
+Therefore, an additional option `-A <ARCH_NAME>` has been added which expands
+into `-DCMAKE_TOOLCHAIN_FILE=<src_dir>/cmake/toolchain/<ARCH_NAME>.cmake`.
+
+### Further operations (deleting, purging, ...)
+
+The `bdir` command supports further operations like the deletion of mappings or
+the purging of the build directory root from abandoned directories. The flags
+for these and other operations can be found in the help of the command.
+(`bdir --help`)
 
 ## TODO:
-* add documentation
 * add unit tests
 * support multiple build directories?

data/bin/builddir_cmake

@@ -1,8 +1,7 @@
 #!/usr/bin/env ruby
 require 'builddir'
 
-# figure out if the src path is needed
-src_dir = nil
+# figure out if the src path which should be added to the real cmake invocation
 append_src_dir = true
 
 # blacklist all flags where concatination of the src dir is not desired
@@ -13,17 +12,43 @@ append_src_dir = false if ARGV.any? { |val| val =~ /^--system-information$/ }
 append_src_dir = false if ARGV.any? { |val| val =~ /^--build$/ }
 append_src_dir = false if ARGV.any? { |val| val =~ /^-E$/ }
 
-if append_src_dir
+# add an option (-A <ARCH_NAME>) to specify an architecture for cross compilation
+# this option is expanded into a CMAKE_TOOLCHAIN_FILE when it can be found
+# in <src_dir>/cmake/toolchains
+arch_idx = ARGV.index('-A')
+arch_idx = nil if arch_idx == ARGV.length-1
+
+# try to find the src path if needed
+src_dir = nil
+if append_src_dir or arch_idx
 	# try to find a mapping
 	mapping = Builddir.loadMapping()
 	mapping ||= []
-	
+
 	currentDir = Dir.pwd
 	entry = Builddir.findExactMapping(mapping,currentDir)
-	src_dir = entry[:srcDir] unless entry.nil? || entry[:type] != :BUILD_DIR
+	src_dir = entry[:srcDir] if entry && entry[:type] == :BUILD_DIR
+
+	if arch_idx and src_dir.nil?
+		$stderr.puts "ERROR! No SrcDir <-> BuildDir mapping could be found."
+		$stderr.puts "The -A option is only usable in a builddir managed build directory."
+		exit -1
+	end
+end
+
+# rewrite the -A option in ARGV to something meaningful for cmake
+if arch_idx
+	toolchain_file = "#{src_dir}/cmake/toolchain/#{ARGV[arch_idx + 1]}.cmake"
+	unless File.file?(toolchain_file)
+		$stderr.puts "ERROR! Toolchain file (#{toolchain_file}) does not exist."
+		exit -1
+	end
+	# delete the parameter of -A and rewrite -A itself
+	ARGV.delete_at arch_idx + 1
+	ARGV[arch_idx] = "-DCMAKE_TOOLCHAIN_FILE=#{toolchain_file}"
 end
 
-unless src_dir.nil?
+if append_src_dir and src_dir
 	system 'cmake', *ARGV, src_dir
 else
 	system 'cmake', *ARGV

data/bin/builddir_generate_source_script

@@ -22,7 +22,7 @@ Trollop::with_standard_exception_handling p do
 	raise Trollop::HelpNeeded if ARGV.size() > 1 # show help screen
 end
 
-file_path = File.join(Builddir.gem_libdir, "data", "builddir_source_script")
+file_path = File.join(Builddir.getGemLibdir, "data", "builddir_source_script")
 
 # write file content to stdout
 if ARGV.size == 0

data/bin/builddir_impl

@@ -5,12 +5,20 @@ require 'trollop'
 
 require 'builddir'
 
+# Generate a non existing build directory path given a base name
+#
+# The function simply appends a count to the base name until a path which
+# does not exist has been found.
+#
+# @param baseDir [String] path to the build directory root
+# @param baseName [String] base name for the build directory
+# @return [String] path to the new directory
 def createBuildDirPath(baseDir,baseName)
-   basePath = Pathname.new("#{baseDir}/#{baseName}")
-   return basePath.to_s unless File.exists?(basePath)
-   i = 1
-   while File.exists?(basePath.to_s + i.to_s) do i += 1 end
-   return basePath.to_s + i.to_s
+	basePath = Pathname.new(File.join(baseDir,baseName))
+	return basePath.to_s unless File.exists?(basePath)
+	i = 1
+	while File.exists?(basePath.to_s + i.to_s) do i += 1 end
+	return basePath.to_s + i.to_s
 end
 
 # redirect stdout to stderr

data/lib/builddir/utils.rb

@@ -6,7 +6,7 @@ module Builddir
 	# http://stackoverflow.com/a/5805783
 	#
 	# @return [String] path to the library directory
-	def Builddir.gem_libdir
+	def Builddir.getGemLibdir
 		t = ["#{File.dirname(File.expand_path($0))}/../lib/#{NAME}",
 					"#{Gem.dir}/gems/#{NAME}-#{VERSION}/lib/#{NAME}"]
 		t.each {|i| return i if File.readable?(i) }

data/lib/builddir/version.rb

@@ -1,4 +1,4 @@
 module Builddir
 	NAME = 'builddir'
-  VERSION = "0.1.1"
+	VERSION = '0.1.2'
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: builddir
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mario Werner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-05 00:00:00.000000000 Z
+date: 2014-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 description: builddir manages mappings between build directories and the associated
@@ -64,7 +64,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -93,17 +93,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: builddir is a little helper tool for C/C++ programmers to manage out-of-source