From ab42c8f739c8bbe5c853a1b23e7e3bfbbd4ac5fe Mon Sep 17 00:00:00 2001 From: zzak Date: Sun, 10 Feb 2013 06:27:23 +0000 Subject: * 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 --- ChangeLog | 4 + lib/rake/doc/README | 196 ----------------------------------- lib/rake/doc/README.rdoc | 187 +++++++++++++++++++++++++++++++++ lib/rake/doc/command_line_usage.rdoc | 17 --- lib/rake/doc/rakefile.rdoc | 6 +- 5 files changed, 194 insertions(+), 216 deletions(-) delete mode 100644 lib/rake/doc/README create mode 100644 lib/rake/doc/README.rdoc diff --git a/ChangeLog b/ChangeLog index 5d77d47c75..3c267c1753 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +Sun Feb 10 15:26:00 2013 Zachary Scott + + * doc/rake/*: Sync Rake rdoc files from upstream + Thu Feb 7 23:13:42 2013 KOSAKI Motohiro * vm_exec.h (DISPATCH_ARCH_DEPEND_WAY): use __asm__ __volatile__ diff --git a/lib/rake/doc/README b/lib/rake/doc/README deleted file mode 100644 index 41668dd727..0000000000 --- a/lib/rake/doc/README +++ /dev/null @@ -1,196 +0,0 @@ -= RAKE -- Ruby Make - -Supporting Rake version: 0.8.6 - -This package contains Rake, a simple ruby build program with -capabilities similar to make. - -Rake has the following features: - -* 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?) - -* Users can specify tasks with prerequisites. - -* Rake supports rule patterns to synthesize implicit tasks. - -* Flexible FileLists that act like arrays but know about manipulating - file names and paths. - -* A library of prepackaged tasks to make building rakefiles easier. For example, - tasks for building tarballs, gems and RDoc output are provided. - -* Supports parallel execution of tasks. - - -== Installation - -=== Gem Installation - -Download and install rake with the following. - - 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 - -=== Simple Example - -First, you must write a "Rakefile" file which contains the build rules. Here's -a simple example: - - task :default => [:test] - - task :test do - ruby "test/unittest.rb" - end - -This Rakefile has two tasks: - -* A task named "test", which - upon invocation - will run a unit test file in - Ruby. -* A task named "default". This task does nothing by itself, but it has exactly - one dependency, namely the "test" task. Invoking the "default" task will - cause Rake to invoke the "test" task as well. - -Running the "rake" command without any options will cause it to run the -"default" task in the Rakefile: - - % ls - Rakefile test/ - % rake - (in /home/some_user/Projects/rake) - ruby test/unittest.rb - ....unit test output here... - -Type "rake --help" for all available options. - - -=== More Information - -* 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] -* For details on writing Rakefiles, see - doc/rakefile.rdoc[http://rake.rubyforge.org/files/doc/rakefile_rdoc.html]. -* For the original announcement of Rake, see - doc/rational.rdoc[http://rake.rubyforge.org/files/doc/rational_rdoc.html]. -* For a glossary of terms, see - doc/glossary.rdoc[http://rake.rubyforge.org/files/doc/glossary_rdoc.html]. - - -== Development - -=== Source Repository - -Rake is currently hosted at github. The github web page is -http://github.com/jimweirich/rake. The public git clone URL is - -* git://github.com/jimweirich/rake.git - -=== Running the Rake Test Suite - -If you wish to run the unit and functional tests that come with Rake: - -* Install the 'session' gem in order to run the functional tests. -* CD into the top project directory of rake. -* Type one of the following: - - rake # If you have a version of rake installed - ruby -Ilib bin/rake # If you do not have a version of rake installed. - -=== Issues and Bug Reports - -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 me -an email (at jim dot weirich at gmail dot com) - - -== Online Resources - -=== Rake References - -* Rake Documentation Home: http://docs.rubyrake.org -* Rake Project Page: http://rubyforge.org/projects/rake -* Rake API Documents: http://rake.rubyforge.org -* Rake Source Code Repo: http://github.com/jimweirich/rake -* Rake Git Repo Clone URL: git://github.com/jimweirich/rake.git - -=== Presentations and Articles about Rake - -* Jim Weirich's 2003 RubyConf presentation: http://onestepback.org/articles/buildingwithrake/ -* Martin Fowler's article on Rake: http://martinfowler.com/articles/rake.html - -== Other Make Reinvisionings ... - -Rake is a late entry in the make replacement field. Here are links to -other projects with similar (and not so similar) goals. - -* http://directory.fsf.org/bras.html -- Bras, one of earliest - implementations of "make in a scripting language". -* http://www.a-a-p.org -- Make in Python -* http://www.aromatic.com/tools/jam.txt -- JAM, Java Automated Make -* http://ant.apache.org -- The Ant project -* http://ppt.perl.org/commands/make/index.html -- Make from the Perl - Power Tools implementation. -* http://search.cpan.org/search?query=PerlBuildSystem -- The Perl Build System -* http://make.rubyforge.org -- Rant, another Ruby make tool. - -== Credits - -[Ryan Dlugosz] For the initial conversation that sparked Rake. - -[nobu.nokada@softhome.net] For the initial patch for rule support. - -[Tilman Sauerbeck ] For the recursive rule patch. - -== License - -Rake is available under an MIT-style license. - -:include: MIT-LICENSE - -== Support - -The Rake homepage is http://rake.rubyforge.org. You can find the Rake -RubyForge page at http://rubyforge.org/projects/rake. - -Feel free to submit commits or feature requests. If you send a patch, -remember to update the corresponding unit tests. If fact, I prefer -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 -(which is mirrored to comp.lang.ruby) or contact -jim dot weirich at gmail.com. - ---- - -= Other stuff - -Author:: Jim Weirich -Requires:: Ruby 1.8.0 or later -License:: Copyright 2003-2008 by Jim Weirich. - Released under an MIT-style license. See the LICENSE file - included in the distribution. - -== Warranty - -This software is provided "as is" and without any express or -implied warranties, including, without limitation, the implied -warranties of merchantibility and fitness for a particular -purpose. diff --git a/lib/rake/doc/README.rdoc b/lib/rake/doc/README.rdoc new file mode 100644 index 0000000000..3879ad4a31 --- /dev/null +++ b/lib/rake/doc/README.rdoc @@ -0,0 +1,187 @@ += RAKE -- Ruby Make + +This package contains Rake, a simple ruby build program with capabilities +similar to make. + +Rake has the following features: + +* 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?) + +* Users can specify tasks with prerequisites. + +* Rake supports rule patterns to synthesize implicit tasks. + +* Flexible FileLists that act like arrays but know about manipulating + file names and paths. + +* A library of prepackaged tasks to make building rakefiles easier. For example, + 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. + +== Installation + +=== Gem Installation + +Download and install rake with the following. + + gem install rake + +== Usage + +=== Simple Example + +First, you must write a "Rakefile" file which contains the build rules. Here's +a simple example: + + task :default => [:test] + + task :test do + ruby "test/unittest.rb" + end + +This Rakefile has two tasks: + +* A task named "test", which - upon invocation - will run a unit test file in + Ruby. +* A task named "default". This task does nothing by itself, but it has exactly + one dependency, namely the "test" task. Invoking the "default" task will + cause Rake to invoke the "test" task as well. + +Running the "rake" command without any options will cause it to run the +"default" task in the Rakefile: + + % ls + Rakefile test/ + % rake + (in /home/some_user/Projects/rake) + ruby test/unittest.rb + ....unit test output here... + +Type "rake --help" for all available options. + + +=== More Information + +* For details on Rake's command-line invocation, read + doc/command_line_usage.rdoc[https://github.com/jimweirich/rake/blob/master/doc/command_line_usage.rdoc] +* For details on writing Rakefiles, see + doc/rakefile.rdoc[https://github.com/jimweirich/rake/blob/master/doc/rakefile.rdoc]. +* For the original announcement of Rake, see + doc/rational.rdoc[https://github.com/jimweirich/rake/blob/master/doc/rational.rdoc]. +* For a glossary of terms, see + doc/glossary.rdoc[https://github.com/jimweirich/rake/blob/master/doc/glossary.rdoc]. + +== Development + +=== Source Repository + +Rake is currently hosted at github. The github web page is +http://github.com/jimweirich/rake. The public git clone URL is + +* git://github.com/jimweirich/rake.git + +=== Running the Rake Test Suite + +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. +* CD into the top project directory of rake. +* Type one of the following: + + rake # If you have a version of rake installed + ruby -Ilib bin/rake # If you do not have a version of rake installed. + +=== Issues and Bug Reports + +Feature requests and bug reports can be made here + +* https://github.com/jimweirich/rake/issues + +Issues and bug reports can also be tracked here: + +* http://www.pivotaltracker.com/projects/28469 + +== Online Resources + +=== Rake References + +* Rake Documentation Home: http://docs.rubyrake.org +* Rake Project Page: http://rubyforge.org/projects/rake +* Rake API Documents: http://rake.rubyforge.org +* Rake Source Code Repo: http://github.com/jimweirich/rake +* 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 + +* Jim Weirich's 2003 RubyConf presentation: + http://onestepback.org/articles/buildingwithrake/ +* Martin Fowler's article on Rake: http://martinfowler.com/articles/rake.html + +== Other Make Reinvisionings ... + +Rake is a late entry in the make replacement field. Here are links to +other projects with similar (and not so similar) goals. + +* http://directory.fsf.org/bras.html -- Bras, one of earliest + implementations of "make in a scripting language". +* http://www.a-a-p.org -- Make in Python +* http://www.aromatic.com/tools/jam.txt -- JAM, Java Automated Make +* http://ant.apache.org -- The Ant project +* http://ppt.perl.org/commands/make/index.html -- Make from the Perl + Power Tools implementation. +* http://search.cpan.org/search?query=PerlBuildSystem -- The Perl Build System +* http://make.rubyforge.org -- Rant, another Ruby make tool. + +== Credits + +[Ryan Dlugosz] For the initial conversation that sparked Rake. + +[nobu.nokada@softhome.net] For the initial patch for rule support. + +[Tilman Sauerbeck ] For the recursive rule patch. + +[Eric Hodel] For aid in maintaining rake. + +== License + +Rake is available under an MIT-style license. + +:include: MIT-LICENSE + +== Support + +The Rake homepage is http://rake.rubyforge.org. You can find the Rake +RubyForge page at http://rubyforge.org/projects/rake. + +Feel free to submit commits or feature requests. If you send a patch, +remember to update the corresponding unit tests. In fact, I prefer +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 +(which is mirrored to comp.lang.ruby) or contact +jim dot weirich at gmail.com. + +--- + += Other stuff + +Author:: Jim Weirich +Requires:: Ruby 1.8.6 or later +License:: Copyright 2003-2011 by Jim Weirich. + Released under an MIT-style license. See the MIT-LICENSE + file included in the distribution. + +== Warranty + +This software is provided "as is" and without any express or +implied warranties, including, without limitation, the implied +warranties of merchantibility and fitness for a particular +purpose. diff --git a/lib/rake/doc/command_line_usage.rdoc b/lib/rake/doc/command_line_usage.rdoc index 688e55a9af..be930018c3 100644 --- a/lib/rake/doc/command_line_usage.rdoc +++ b/lib/rake/doc/command_line_usage.rdoc @@ -23,13 +23,6 @@ Options are: stardard output. If _output_ is stderr, or if it is missing, then the backtrace output is sent to standard error. -[--classic-namespace (-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 require - 'rake/classic_namespace' in your Rakefile to get the - classic behavior. - [--comments] Used in combination with the -W options to force the output to contain commented options only. This is the reverse of @@ -102,16 +95,6 @@ Options are: [--rakelibdir _rakelibdir_ (-R)] Auto-import any .rake files in RAKELIBDIR. (default is 'rakelib') -[--reduce-compat] - - 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. - [--require _name_ (-r)] Require _name_ before executing the Rakefile. diff --git a/lib/rake/doc/rakefile.rdoc b/lib/rake/doc/rakefile.rdoc index a00c9fd21e..01ecc92f63 100644 --- a/lib/rake/doc/rakefile.rdoc +++ b/lib/rake/doc/rakefile.rdoc @@ -193,7 +193,7 @@ example, if the "release" task expected a parameter named or - RELEASE_VERSION rake release + RELEASE_VERSION=0.8.2 rake release will work. Environment variable names must either match 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 powerful meta-programming capabilities w.r.t. task execution, but -should be used with cation. +should be used with caution. == 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 ... - rule '.java' => [ + rule '.class' => [ proc { |tn| tn.sub(/\.class$/, '.java').sub(/^classes\//, 'src/') } ] do |t| java_compile(t.source, t.name) -- cgit v1.2.3