Object

Constants

CLEAN

CLOBBER

FileCreationTask

FileList

Alias FileList to be available at the top level.

FileTask

HostInfo

Configuration information about an upload host system.

name

Name of host system.
webdir

Base directory for the web information for the application. The application name (APP) is appended to this directory before using.
pkgdir

Directory on the host system where packages can be placed.

RAKEVERSION

Copyright 2003, 2004, 2005, 2006, 2007, 2008 by Jim Weirich (jim@weirichhouse.org)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.

= Rake -- Ruby Make

This is the main file for the Rake application.  Normally it is referenced
as a library via a require statement, but it can be distributed
independently as an application.

RakeApp

Task

The following classes used to be in the top level namespace. Loading this file enables compatibility with older Rakefile that referenced Task from the top level.

Public Instance Methods

desc(description) click to toggle source

Describe the next rake task.

Example:

desc "Run the Unit Tests"
task :test => [:build]
  runtests
end

# File lib/rake.rb, line 932
def desc(description)
  Rake.application.last_description = description
end

directory(dir) click to toggle source

Declare a set of files tasks to create the given directories on demand.

Example:

directory "testdata/doc"

# File lib/rake.rb, line 879
def directory(dir)
  Rake.each_dir_parent(dir) do |d|
    file_create d do |t|
      mkdir_p t.name if ! File.exist?(t.name)
    end
  end
end

file(*args, &block) click to toggle source

Declare a file task.

Example:

 file "config.cfg" => ["config.template"] do
   open("config.cfg", "w") do |outfile|
     open("config.template") do |infile|
       while line = infile.gets
         outfile.puts line
       end
     end
   end
end

# File lib/rake.rb, line 864
def file(*args, &block)
  Rake::FileTask.define_task(*args, &block)
end

file_create(args, &block) click to toggle source

Declare a file creation task. (Mainly used for the directory command).

# File lib/rake.rb, line 870
def file_create(args, &block)
  Rake::FileCreationTask.define_task(args, &block)
end

import(*fns) click to toggle source

Import the partial Rakefiles fn. Imported files are loaded after the current file is completely loaded. This allows the import statement to appear anywhere in the importing file, and yet allowing the imported files to depend on objects defined in the importing file.

A common use of the import statement is to include files containing dependency declarations.

See also the –rakelibdir command line option.

Example:

import ".depend", "my_rules"

# File lib/rake.rb, line 949
def import(*fns)
  fns.each do |fn|
    Rake.application.add_import(fn)
  end
end

multitask(args, &block) click to toggle source

Declare a task that performs its prerequisites in parallel. Multitasks does not guarantee that its prerequisites will execute in any given order (which is obvious when you think about it)

Example:

multitask :deploy => [:deploy_gem, :deploy_rdoc]

# File lib/rake.rb, line 894
def multitask(args, &block)
  Rake::MultiTask.define_task(args, &block)
end

namespace(name=nil, &block) click to toggle source

Create a new rake namespace and use it for evaluating the given block. Returns a NameSpace object that can be used to lookup tasks defined in the namespace.

E.g.

ns = namespace "nested" do
  task :run
end
task_run = ns[:run] # find :run in the given namespace.

# File lib/rake.rb, line 909
def namespace(name=nil, &block)
  Rake.application.in_namespace(name, &block)
end

rule(*args, &block) click to toggle source

Declare a rule for auto-tasks.

Example:

rule '.o' => '.c' do |t|
  sh %{cc -o #{t.name} #{t.source}}
end

# File lib/rake.rb, line 920
def rule(*args, &block)
  Rake::Task.create_rule(*args, &block)
end

task(*args, &block) click to toggle source

Declare a basic task.

Example:

task :clobber => [:clean] do
  rm_rf "html"
end

# File lib/rake.rb, line 846
def task(*args, &block)
  Rake::Task.define_task(*args, &block)
end

Home Classes Methods

In Files

Parent

Namespace

Methods

Included Modules

Files

Class/Module Index

Object

Constants

Public Instance Methods