1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

* doc/rake/*: Sync Rake rdoc files from upstream

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@39189 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
zzak 2013-02-10 06:27:23 +00:00
parent dd7a64d100
commit ab42c8f739
4 changed files with 35 additions and 57 deletions

View file

@ -1,3 +1,7 @@
Sun Feb 10 15:26:00 2013 Zachary Scott <zachary@zacharyscott.net>
* doc/rake/*: Sync Rake rdoc files from upstream
Thu Feb 7 23:13:42 2013 KOSAKI Motohiro <kosaki.motohiro@gmail.com> Thu Feb 7 23:13:42 2013 KOSAKI Motohiro <kosaki.motohiro@gmail.com>
* vm_exec.h (DISPATCH_ARCH_DEPEND_WAY): use __asm__ __volatile__ * vm_exec.h (DISPATCH_ARCH_DEPEND_WAY): use __asm__ __volatile__

View file

@ -1,9 +1,7 @@
= RAKE -- Ruby Make = RAKE -- Ruby Make
Supporting Rake version: 0.8.6 This package contains Rake, a simple ruby build program with capabilities
similar to make.
This package contains Rake, a simple ruby build program with
capabilities similar to make.
Rake has the following features: Rake has the following features:
@ -19,31 +17,20 @@ Rake has the following features:
file names and paths. file names and paths.
* A library of prepackaged tasks to make building rakefiles easier. For example, * A library of prepackaged tasks to make building rakefiles easier. For example,
tasks for building tarballs, gems and RDoc output are provided. tasks for building tarballs and publishing to FTP or SSH sites. (Formerly
tasks for building RDoc and Gems were included in rake but they're now
available in RDoc and RubyGems respectively.)
* Supports parallel execution of tasks. * Supports parallel execution of tasks.
== Installation == Installation
=== Gem Installation === Gem Installation
Download and install rake with the following. Download and install rake with the following.
gem install rake gem install rake
=== Normal Installation
You can download the source tarball of the latest version of Rake from
* http://rubyforge.org/project/showfiles.php?group_id=50
Extract the tarball and run
% ruby install.rb
from its distribution directory.
== Usage == Usage
=== Simple Example === Simple Example
@ -52,7 +39,7 @@ First, you must write a "Rakefile" file which contains the build rules. Here's
a simple example: a simple example:
task :default => [:test] task :default => [:test]
task :test do task :test do
ruby "test/unittest.rb" ruby "test/unittest.rb"
end end
@ -81,14 +68,13 @@ Type "rake --help" for all available options.
=== More Information === More Information
* For details on Rake's command-line invocation, read * For details on Rake's command-line invocation, read
doc/command_line_usage.rdoc[http://rake.rubyforge.org/files/doc/command_line_usage_rdoc.html] doc/command_line_usage.rdoc[https://github.com/jimweirich/rake/blob/master/doc/command_line_usage.rdoc]
* For details on writing Rakefiles, see * For details on writing Rakefiles, see
doc/rakefile.rdoc[http://rake.rubyforge.org/files/doc/rakefile_rdoc.html]. doc/rakefile.rdoc[https://github.com/jimweirich/rake/blob/master/doc/rakefile.rdoc].
* For the original announcement of Rake, see * For the original announcement of Rake, see
doc/rational.rdoc[http://rake.rubyforge.org/files/doc/rational_rdoc.html]. doc/rational.rdoc[https://github.com/jimweirich/rake/blob/master/doc/rational.rdoc].
* For a glossary of terms, see * For a glossary of terms, see
doc/glossary.rdoc[http://rake.rubyforge.org/files/doc/glossary_rdoc.html]. doc/glossary.rdoc[https://github.com/jimweirich/rake/blob/master/doc/glossary.rdoc].
== Development == Development
@ -103,6 +89,7 @@ http://github.com/jimweirich/rake. The public git clone URL is
If you wish to run the unit and functional tests that come with Rake: If you wish to run the unit and functional tests that come with Rake:
* Install the 'flexmock' gem
* Install the 'session' gem in order to run the functional tests. * Install the 'session' gem in order to run the functional tests.
* CD into the top project directory of rake. * CD into the top project directory of rake.
* Type one of the following: * Type one of the following:
@ -112,14 +99,13 @@ If you wish to run the unit and functional tests that come with Rake:
=== Issues and Bug Reports === Issues and Bug Reports
Bugs, features requests and other issues can be logged at Feature requests and bug reports can be made here
* http://onestepback.org/redmine/projects/show/rake * https://github.com/jimweirich/rake/issues
You will need an account to before you can post issues. Register at Issues and bug reports can also be tracked here:
http://onestepback.org/redmine/account/register. Or you can send me
an email (at jim dot weirich at gmail dot com)
* http://www.pivotaltracker.com/projects/28469
== Online Resources == Online Resources
@ -130,10 +116,13 @@ an email (at jim dot weirich at gmail dot com)
* Rake API Documents: http://rake.rubyforge.org * Rake API Documents: http://rake.rubyforge.org
* Rake Source Code Repo: http://github.com/jimweirich/rake * Rake Source Code Repo: http://github.com/jimweirich/rake
* Rake Git Repo Clone URL: git://github.com/jimweirich/rake.git * Rake Git Repo Clone URL: git://github.com/jimweirich/rake.git
* Rake Bug Reports: https://github.com/jimweirich/rake/issues
* Rake Continuous Build Server: https://travis-ci.org/#!/jimweirich/rake
=== Presentations and Articles about Rake === Presentations and Articles about Rake
* Jim Weirich's 2003 RubyConf presentation: http://onestepback.org/articles/buildingwithrake/ * Jim Weirich's 2003 RubyConf presentation:
http://onestepback.org/articles/buildingwithrake/
* Martin Fowler's article on Rake: http://martinfowler.com/articles/rake.html * Martin Fowler's article on Rake: http://martinfowler.com/articles/rake.html
== Other Make Reinvisionings ... == Other Make Reinvisionings ...
@ -159,6 +148,8 @@ other projects with similar (and not so similar) goals.
[<b>Tilman Sauerbeck <tilman@code-monkey.de></b>] For the recursive rule patch. [<b>Tilman Sauerbeck <tilman@code-monkey.de></b>] For the recursive rule patch.
[<b>Eric Hodel</b>] For aid in maintaining rake.
== License == License
Rake is available under an MIT-style license. Rake is available under an MIT-style license.
@ -171,7 +162,7 @@ The Rake homepage is http://rake.rubyforge.org. You can find the Rake
RubyForge page at http://rubyforge.org/projects/rake. RubyForge page at http://rubyforge.org/projects/rake.
Feel free to submit commits or feature requests. If you send a patch, Feel free to submit commits or feature requests. If you send a patch,
remember to update the corresponding unit tests. If fact, I prefer remember to update the corresponding unit tests. In fact, I prefer
new feature to be submitted in the form of new unit tests. new feature to be submitted in the form of new unit tests.
For other information, feel free to ask on the ruby-talk mailing list For other information, feel free to ask on the ruby-talk mailing list
@ -183,10 +174,10 @@ jim dot weirich at gmail.com.
= Other stuff = Other stuff
Author:: Jim Weirich <jim.weirich@gmail.com> Author:: Jim Weirich <jim.weirich@gmail.com>
Requires:: Ruby 1.8.0 or later Requires:: Ruby 1.8.6 or later
License:: Copyright 2003-2008 by Jim Weirich. License:: Copyright 2003-2011 by Jim Weirich.
Released under an MIT-style license. See the LICENSE file Released under an MIT-style license. See the MIT-LICENSE
included in the distribution. file included in the distribution.
== Warranty == Warranty

View file

@ -23,13 +23,6 @@ Options are:
stardard output. If _output_ is <tt>stderr</tt>, or if it is stardard output. If _output_ is <tt>stderr</tt>, or if it is
missing, then the backtrace output is sent to standard error. missing, then the backtrace output is sent to standard error.
[<tt>--classic-namespace</tt> (-n)]
Import the Task, FileTask, and FileCreateTask into the top-level
scope to be compatible with older versions of Rake. Alternatively
you can include the line <code>require
'rake/classic_namespace'</code> in your Rakefile to get the
classic behavior.
[<tt>--comments</tt>] [<tt>--comments</tt>]
Used in combination with the -W options to force the output to Used in combination with the -W options to force the output to
contain commented options only. This is the reverse of contain commented options only. This is the reverse of
@ -102,16 +95,6 @@ Options are:
[<tt>--rakelibdir</tt> _rakelibdir_ (-R)] [<tt>--rakelibdir</tt> _rakelibdir_ (-R)]
Auto-import any .rake files in RAKELIBDIR. (default is 'rakelib') Auto-import any .rake files in RAKELIBDIR. (default is 'rakelib')
[<tt>--reduce-compat</tt>]
Remove the DSL commands from the Object inheritance hierarchy and
do not define top level constants. This reduces the backwards
compatibility of Rake, but allows rake to be used with software
that would otherwise have conflicting definitions.
*NOTE:* The next major version of Rake will only be able to be run
in "reduce-compat" mode.
[<tt>--require</tt> _name_ (-r)] [<tt>--require</tt> _name_ (-r)]
Require _name_ before executing the Rakefile. Require _name_ before executing the Rakefile.

View file

@ -193,7 +193,7 @@ example, if the "release" task expected a parameter named
or or
RELEASE_VERSION rake release RELEASE_VERSION=0.8.2 rake release
will work. Environment variable names must either match the task will work. Environment variable names must either match the task
parameter exactly, or match an all-uppercase version of the task parameter exactly, or match an all-uppercase version of the task
@ -291,7 +291,7 @@ Running this example:
The ability to programmatically manipulate tasks gives rake very The ability to programmatically manipulate tasks gives rake very
powerful meta-programming capabilities w.r.t. task execution, but powerful meta-programming capabilities w.r.t. task execution, but
should be used with cation. should be used with caution.
== Rules == Rules
@ -337,7 +337,7 @@ required on *rule* when the first argument is a regular expression.
The following rule might be used for Java files ... The following rule might be used for Java files ...
rule '.java' => [ rule '.class' => [
proc { |tn| tn.sub(/\.class$/, '.java').sub(/^classes\//, 'src/') } proc { |tn| tn.sub(/\.class$/, '.java').sub(/^classes\//, 'src/') }
] do |t| ] do |t|
java_compile(t.source, t.name) java_compile(t.source, t.name)