File: rake.rb

Included modules

Public Instance methods

Describe the next rake task.

Example:

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

     # File lib/rake.rb, line 843
843: def desc(description)
844:   Rake.application.last_description = description
845: end

directory(dir)

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

Example:

  directory "testdata/doc"

     # File lib/rake.rb, line 790
790: def directory(dir)
791:   Rake.each_dir_parent(dir) do |d|
792:     file_create d do |t|
793:       mkdir_p t.name if ! File.exist?(t.name)
794:     end
795:   end
796: end

file(args, &block)

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 775
775: def file(args, &block)
776:   Rake::FileTask.define_task(args, &block)
777: end

file_create(args, &block)

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

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

import(*fns)

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 860
860: def import(*fns)
861:   fns.each do |fn|
862:     Rake.application.add_import(fn)
863:   end
864: end

multitask(args, &block)

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 805
805: def multitask(args, &block)
806:   Rake::MultiTask.define_task(args, &block)
807: end

namespace(name=nil, &block)

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 820
820: def namespace(name=nil, &block)
821:   Rake.application.in_namespace(name, &block)
822: end

rule(*args, &block)

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 831
831: def rule(*args, &block)
832:   Rake::Task.create_rule(*args, &block)
833: end

task(*args, &block)

Declare a basic task.

Example:

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

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