RAKE(1) Ruby Programmers Reference Guide RAKE(1)NAME
rake -- Ruby Make
SYNOPSIS
rake [--f Rakefile] [--version] [-CGNPgnqstv] [-D [PATTERN]] [-E CODE] [-I LIBDIR] [-R RAKELIBDIR] [-T [PATTERN]] [-e CODE] [-p CODE]
[-r MODULE] [--rules] [variable=value] target ...
DESCRIPTION
Rake is a simple ruby(1) build program with capabilities similar to the regular make(1) command.
Rake has the following features:
o Rakefiles (Rake's version of Makefiles) are completely defined in standard Ruby syntax. No XML files to edit. No quirky Makefile syntax
to worry about (is that a tab or a space?).
o Users can specify tasks with prerequisites.
o Rake supports rule patterns to synthesize implicit tasks.
o Flexible FileLists that act like arrays but know about manipulating file names and paths.
o A library of prepackaged tasks to make building rakefiles easier.
OPTIONS --version Display the program version.
-C
--classic-namespace
Put Task and FileTask in the top level namespace
-D [PATTERN]
--describe [PATTERN]
Describe the tasks (matching optional PATTERN), then exit.
-E CODE
--execute-continue CODE
Execute some Ruby code, then continue with normal task processing.
-G
--no-system
--nosystem Use standard project Rakefile search paths, ignore system wide rakefiles.
-I LIBDIR
--libdir LIBDIR Include LIBDIR in the search path for required modules.
-N
--no-search
--nosearch Do not search parent directories for the Rakefile.
-P
--prereqs Display the tasks and dependencies, then exit.
-R RAKELIBDIR
--rakelib RAKELIBDIR
--rakelibdir RAKELIBDIR
Auto-import any .rake files in RAKELIBDIR. (default is rakelib )
-T [PATTERN]
--tasks [PATTERN] Display the tasks (matching optional PATTERN) with descriptions, then exit.
-e CODE
--execute CODE Execute some Ruby code and exit.
-f FILE
--rakefile FILE Use FILE as the rakefile.
-h
--help Prints a summary of options.
-g
--system Using system wide (global) rakefiles (usually ~/.rake/*.rake ).
-n
--dry-run Do a dry run without executing actions.
-p CODE
--execute-print CODE
Execute some Ruby code, print the result, then exit.
-q
--quiet Do not log messages to standard output.
-r MODULE
--require MODULE Require MODULE before executing rakefile.
-s
--silent Like --quiet, but also suppresses the 'in directory' announcement.
-t
--trace Turn on invoke/execute tracing, enable full backtrace.
-v
--verbose Log message to standard output (default).
--rules Trace the rules resolution.
SEE ALSO ruby(1)make(1)
http://rake.rubyforge.org/
REPORTING BUGS
Bugs, features requests and other issues can be logged at <http://onestepback.org/redmine/projects/show/rake>.
You will need an account to before you can post issues. Register at <http://onestepback.org/redmine/account/register>. Or you can send an
email to the author.
AUTHOR
Rake is written by Jim Weirich <jim@weirichhouse.org>
UNIX November 7, 2012 UNIX
Check Out this Related Man Page
DH_RUBY(1)DH_RUBY(1)NAME
dh_ruby - debhelper7 build system for Ruby software
SYNOPSIS
dh_ruby [OPTIONS]
DESCRIPTION
dh_ruby is a Debhelper 7 build system for Ruby software. It will automatically build and install files contained in Ruby packages, trying
to work as close to Rubygems as possible but respecting Debian standards for Ruby packages.
dh_ruby can automatically run your tests against all supported Ruby versions, see the "FILES" section below.
See dh_ruby --help for details.
OPTIONS --clean, --configure, --build, --test, --install
Commands called by debhelper at various steps of the build process.
-h, --help
Displays dh_ruby usage information.
-v, --version
Displays dh_ruby version information.
--setuprb
This option indicates that the build should use setup.rb rather than the usual gem-based build. To take effect, this option must come
first !
ENVIRONMENT VARIABLES
DH_RUBY_IGNORE_TESTS
This is a space-separated list of tests that dh_ruby will ignore during package build. The available test names are "require-rubygems"
plus the names of all supported Ruby versions. At the time of writing, only "ruby1.8" and "ruby1.9.1" are supported.
If set to "all", all tests will be ignored during the package build.
DH_RUBY_USE_DH_AUTO_INSTALL_DESTDIR
If this variable is defined (to anything), dh_ruby will respect the directory informed by dh_auto_install(1), usually debian/tmp. By
default, gem2deb will install files to debian/package, where package is the first binary package listed in debian/control.
This is useful for multi-binary source packages, where you will have all files installed to debian/tmp, and can them split the files
into separate packages by using debian/package.install.
DH_RUBY_GEMSPEC
Determines which file contain the gem specification with package metadata. By default, dh_ruby will read metadata from a .gemspec file
in the root of source package directory. You can use this variable to override that if want to provide custom metadata for the Debian
package.
In the case there are more than one .gemspec in the source package root, you will need to use DH_RUBY_GEMSPEC to instruct dh_ruby about
which one to use.
FILES
debian/ruby-test-files.yaml, debian/ruby-tests.rake, debian/ruby-tests.rb
Theses files can be used to explicitly tell dh_ruby how to run the tests in your package. When running the tests, dh_ruby will
automatically set RUBYLIB to include the appropriate directories where the package files were installed in your package to make sure
the tests use them instead of the files in the source directory.
Your package can only contain at most one of these files.
debian/ruby-test-files.yaml must contain a YAML document with a list of test files to be run. If the package metadata contains an
explicit list of test files, gem2deb(1) will automatically generate this file for you. Example from ruby-mime-types:
---
- test/test_mime_type.rb
- test/test_mime_types.rb
debian/ruby-tests.rake can be used to run the tests with rake(1). If you use this file, your package must Build-Depend on the rake
package. You can use anything you would use in a regular Rakefile, but you must define a default task. gem2deb includes utility test
task that makes it easier for you by creating a default task automatically. Example:
require 'gem2deb/rake/testtask'
Gem2Deb:Rake::TestTask.new do |t|
t.test_files = FileList['test/*_test.rb']
end
If debian/ruby-tests.rb exists, it will be run with each supported Ruby version, and must finish with a exit status of 0, otherwise
dh_ruby assumes the tests failed. A simple example:
require 'test/unit'
require 'mypackage' # if 'mypackage.rb' or 'mypackage.so' was not installed properly, this will fail
class MyPackageTest < Test::Unit::TestCase
def test_features
assert_equal 4, MyPackage.sum(2,2)
end
end
debian/require-rubygems.overrides
Fine-tune the "require-rubygems" test. If the package has a very good reason to actually `require "rubygems"`, you can use this file as
a whitelist of files allowed to have `require "rubygems"`.
This file is expect to contain a YAML document with a list of files that must be ignored when checking for `require "rubygems"` lines.
Example:
---
- debian/ruby-foo/usr/lib/ruby/vendor_ruby/foo.rb
- debian/ruby-foo/usr/lib/ruby/vendor_ruby/foo/rubygems.rg
As you can see above, you have to list filenames based on their corresponding install locations in the package temporary install
directory, i.e. `debian/${pkg}/..`
SEE ALSO gem2deb(1)COPYRIGHT AND AUTHORS
Copyright (c) 2011, Lucas Nussbaum <lucas@debian.org>
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
2012-05-17 DH_RUBY(1)