In Files

Parent

Object

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
932: def desc(description)
933:   Rake.application.last_description = description
934: 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
879: def directory(dir)
880:   Rake.each_dir_parent(dir) do |d|
881:     file_create d do |t|
882:       mkdir_p t.name if ! File.exist?(t.name)
883:     end
884:   end
885: 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
864: def file(*args, &block)
865:   Rake::FileTask.define_task(*args, &block)
866: 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
870: def file_create(args, &block)
871:   Rake::FileCreationTask.define_task(args, &block)
872: 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
949: def import(*fns)
950:   fns.each do |fn|
951:     Rake.application.add_import(fn)
952:   end
953: 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
894: def multitask(args, &block)
895:   Rake::MultiTask.define_task(args, &block)
896: 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
909: def namespace(name=nil, &block)
910:   Rake.application.in_namespace(name, &block)
911: 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
920: def rule(*args, &block)
921:   Rake::Task.create_rule(*args, &block)
922: 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
846: def task(*args, &block)
847:   Rake::Task.define_task(*args, &block)
848: end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.