jimweirich-rake 0.8.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. data/CHANGES +364 -0
  2. data/MIT-LICENSE +21 -0
  3. data/README +242 -0
  4. data/Rakefile +413 -0
  5. data/TODO +20 -0
  6. data/bin/rake +31 -0
  7. data/doc/example/Rakefile1 +38 -0
  8. data/doc/example/Rakefile2 +35 -0
  9. data/doc/example/a.c +6 -0
  10. data/doc/example/b.c +6 -0
  11. data/doc/example/main.c +11 -0
  12. data/doc/glossary.rdoc +51 -0
  13. data/doc/jamis.rb +591 -0
  14. data/doc/proto_rake.rdoc +127 -0
  15. data/doc/rake.1.gz +0 -0
  16. data/doc/rakefile.rdoc +411 -0
  17. data/doc/rational.rdoc +151 -0
  18. data/doc/release_notes/rake-0.4.14.rdoc +23 -0
  19. data/doc/release_notes/rake-0.4.15.rdoc +35 -0
  20. data/doc/release_notes/rake-0.5.0.rdoc +53 -0
  21. data/doc/release_notes/rake-0.5.3.rdoc +78 -0
  22. data/doc/release_notes/rake-0.5.4.rdoc +46 -0
  23. data/doc/release_notes/rake-0.6.0.rdoc +141 -0
  24. data/doc/release_notes/rake-0.7.0.rdoc +119 -0
  25. data/doc/release_notes/rake-0.7.1.rdoc +59 -0
  26. data/doc/release_notes/rake-0.7.2.rdoc +121 -0
  27. data/doc/release_notes/rake-0.7.3.rdoc +47 -0
  28. data/doc/release_notes/rake-0.8.0.rdoc +114 -0
  29. data/install.rb +88 -0
  30. data/lib/rake/classic_namespace.rb +8 -0
  31. data/lib/rake/clean.rb +33 -0
  32. data/lib/rake/contrib/compositepublisher.rb +24 -0
  33. data/lib/rake/contrib/ftptools.rb +153 -0
  34. data/lib/rake/contrib/publisher.rb +75 -0
  35. data/lib/rake/contrib/rubyforgepublisher.rb +18 -0
  36. data/lib/rake/contrib/sshpublisher.rb +47 -0
  37. data/lib/rake/contrib/sys.rb +209 -0
  38. data/lib/rake/gempackagetask.rb +103 -0
  39. data/lib/rake/loaders/makefile.rb +40 -0
  40. data/lib/rake/packagetask.rb +184 -0
  41. data/lib/rake/rake_test_loader.rb +5 -0
  42. data/lib/rake/rdoctask.rb +147 -0
  43. data/lib/rake/ruby182_test_unit_fix.rb +23 -0
  44. data/lib/rake/runtest.rb +23 -0
  45. data/lib/rake/tasklib.rb +18 -0
  46. data/lib/rake/testtask.rb +161 -0
  47. data/lib/rake.rb +2312 -0
  48. data/test/capture_stdout.rb +26 -0
  49. data/test/contrib/testsys.rb +47 -0
  50. data/test/data/chains/Rakefile +15 -0
  51. data/test/data/default/Rakefile +19 -0
  52. data/test/data/dryrun/Rakefile +22 -0
  53. data/test/data/file_creation_task/Rakefile +30 -0
  54. data/test/data/imports/Rakefile +19 -0
  55. data/test/data/imports/deps.mf +1 -0
  56. data/test/data/multidesc/Rakefile +17 -0
  57. data/test/data/namespace/Rakefile +57 -0
  58. data/test/data/rakelib/test1.rb +3 -0
  59. data/test/data/rbext/rakefile.rb +3 -0
  60. data/test/data/sample.mf +9 -0
  61. data/test/data/statusreturn/Rakefile +8 -0
  62. data/test/data/unittest/Rakefile +1 -0
  63. data/test/filecreation.rb +32 -0
  64. data/test/functional.rb +15 -0
  65. data/test/rake_test_setup.rb +5 -0
  66. data/test/reqfile.rb +3 -0
  67. data/test/reqfile2.rb +3 -0
  68. data/test/session_functional.rb +267 -0
  69. data/test/shellcommand.rb +3 -0
  70. data/test/test_application.rb +504 -0
  71. data/test/test_clean.rb +14 -0
  72. data/test/test_definitions.rb +82 -0
  73. data/test/test_earlytime.rb +35 -0
  74. data/test/test_extension.rb +63 -0
  75. data/test/test_file_creation_task.rb +62 -0
  76. data/test/test_file_task.rb +139 -0
  77. data/test/test_filelist.rb +618 -0
  78. data/test/test_fileutils.rb +239 -0
  79. data/test/test_ftp.rb +59 -0
  80. data/test/test_invocation_chain.rb +75 -0
  81. data/test/test_makefile_loader.rb +23 -0
  82. data/test/test_multitask.rb +45 -0
  83. data/test/test_namespace.rb +36 -0
  84. data/test/test_package_task.rb +116 -0
  85. data/test/test_pathmap.rb +209 -0
  86. data/test/test_rake.rb +34 -0
  87. data/test/test_require.rb +33 -0
  88. data/test/test_rules.rb +347 -0
  89. data/test/test_task_arguments.rb +76 -0
  90. data/test/test_task_manager.rb +148 -0
  91. data/test/test_tasks.rb +372 -0
  92. data/test/test_test_task.rb +75 -0
  93. data/test/test_top_level_functions.rb +84 -0
  94. metadata +173 -0
data/CHANGES ADDED
@@ -0,0 +1,364 @@
1
+ = Rake Changelog
2
+
3
+ == Pre-Version 0.8.2
4
+
5
+ * Fixed bug in package task so that it will include the subdir
6
+ directory in the package for testing. (Bug found by Adam Majer)
7
+
8
+ * Added ENV var to rakefile to prevent OS X from including extended
9
+ attribute junk in a tar file. (Bug found by Adam Majer)
10
+
11
+ * Fixed filename dependency order bug in test_inspect_pending and
12
+ test_to_s_pending. (Bug found by Adam Majer)
13
+
14
+ * Fixed check for file utils options to make them immune to the
15
+ symbol/string differences. (Patch supplied by Edwin Pratomo)
16
+
17
+ * Fixed bug with rules involving multiple source (Patch supplied by
18
+ Emanuel Inderm�hle)
19
+
20
+ * Switched from getoptlong to optparse (patches supplied by Edwin
21
+ Pratomo (edpratomo@yahoo.co.id))
22
+
23
+ * The -T option will now attempt to dynamically sense the size of the
24
+ terminal. RAKE_COLUMNS will override any dynamic sensing.
25
+
26
+ * FileList#clone and FileList#dup have better sematics w.r.t. taint
27
+ and freeze.
28
+
29
+ * Added ability clear prerequisites, and/or actions from an existing
30
+ task.
31
+
32
+ * Added the ability to reenable a task to be invoked a second time.
33
+
34
+ == Version 0.8.1
35
+
36
+ * Removed requires on parsedate.rb (in Ftptools)
37
+ * Removed ftools from rake.rb. Made it options in sys.rb
38
+
39
+ == Version 0.8.0
40
+
41
+ * Added task parameters (e.g. "rake build[version7]")
42
+ * Made task parameters passable to prerequisites.
43
+ * Comments are limited to 80 columns or so (suggested by Jamis Buck).
44
+ * Added -D to display full comments (suggested by Jamis Buck).
45
+ * The rake program will set the status value used in any explicit
46
+ exit(n) calls. (patch provided by Stephen Touset)
47
+ * Fixed error in functional tests that were not including session (and
48
+ silently skipping the functionl tests.
49
+ * Removed --usage and make -h the same as -H.
50
+ * Make a prettier inspect for tasks.
51
+
52
+ == Version 0.7.3
53
+
54
+ * Added existing and existing! methods to FileList
55
+ * FileLists now claim to be Arrays (via is_a?) to get better support
56
+ from the FileUtil module.
57
+ * Added init and top_level for custom rake applications.
58
+
59
+ == Version 0.7.2
60
+
61
+ * Error messages are now send to stderr rather than stdout (from
62
+ Payton Quackenbush).
63
+ * Better error handling on invalid command line arguments (from Payton
64
+ Quackenbush).
65
+ * Added rcov task and updated unit testing for better code coverage.
66
+ * Fixed some bugs where the application object was going to the global
67
+ appliation instead of using its own data.
68
+ * Added square and curly bracket patterns to FileList#include (Tilman
69
+ Sauerbeck).
70
+ * Added plain filename support to rule dependents (suggested by Nobu
71
+ Nakada).
72
+ * Added pathmap support to rule dependents.
73
+ * Added a 'tasks' method to a namespace to get a list of tasks
74
+ associated with the namespace.
75
+ * Fixed the method name leak from FileUtils (bug found by Glenn
76
+ Vanderburg).
77
+ * Added rake_extension to handle detection of extension collisions.
78
+ * Added test for noop, bad_option and verbose flags to sh command.
79
+ * Removed dependency on internal fu_xxx functions from FileUtils.
80
+ * Added a 'shame' task to the Rakefile.
81
+ * Added tar_command and zip_command options to the Package task.
82
+ * Added a description to the gem task in GemPackageTask.
83
+ * Fixed a bug when rules have multiple prerequisites (patch by Joel
84
+ VanderWerf)
85
+ * Added a protected 'require "rubygems"' to test/test_application to
86
+ unbreak cruisecontrol.rb.
87
+ * Added the handful of RakeFileUtils to the private method as well.
88
+ * Added block based exclusion.
89
+ * The clean task will no longer delete 'core' if it is a directory.
90
+ * Removed rake_dup. Now we just simply rescue a bad dup.
91
+ * Refactored the FileList reject logic to remove duplication.
92
+ * Removed if __FILE__ at the end of the rake.rb file.
93
+
94
+ == Version 0.7.1
95
+
96
+ * Added optional filter parameter to the --tasks command line option.
97
+ * Added flatten to allow rule transform procs to return lists of
98
+ prereqs (Joel VanderWerf provided patch).
99
+ * Added pathmap to String and FileList.
100
+ * The -r option will now load .rake files (but a straight require
101
+ doesn't yet). NOTE: This is experimental ... it may be
102
+ discontinued.
103
+ * The -f option without a value will disable the search for a
104
+ Rakefile. The assumption is that the -r files are adequate.
105
+ * Fixed the safe_ln function to fall back to cp in more error
106
+ scenarios.
107
+
108
+ == Version 0.7.0
109
+
110
+ * Added Rake.original_dir to return the original starting directory of
111
+ the rake application.
112
+ * Added safe_ln support for openAFS (from Ludvig Omholt).
113
+ * Added --trace reminder on short exception messages (David Heinemeier
114
+ Hansson suggestion).
115
+ * Added multitask declaration that executes prerequisites in
116
+ parallel. (Doug Young providied an initial implementation).
117
+ * Fixed missing_const hack to be compatible with Rails. (Jamis Buck
118
+ supplied test case).
119
+ * Made the RDoc task default to internal (in-process) RDoc formatting.
120
+ The old behavior is still available by setting the +external+ flag
121
+ to true.
122
+ * Rakefiles are now loaded with the expanded path to prevent
123
+ accidental polution from the Ruby load path.
124
+ * The +namespace+ command now returns a NameSpace object that can be
125
+ used to lookup tasks defined in that namespace. This allows for
126
+ better anonymous namespace behavior.
127
+ * Task objects my now be used in prerequisite lists directly.
128
+
129
+ == Version 0.6.1
130
+
131
+ * Rebuilt 0.6.0 gem without signing.
132
+
133
+ == Version 0.6.0
134
+
135
+ * Fixed file creation bug in the unit tests (caused infinite loop on
136
+ windows).
137
+ * Fixed bug where session based functional tests were run under
138
+ windows.
139
+ * Fixed bug in directory tasks so that updating a directory will not
140
+ retrigger file tasks depending on the directory (see
141
+ FileCreationTask and EarlyTime).
142
+ * Added egrep to FileList
143
+ * ruby command now runs same ruby version as rake.
144
+ * Added investigation to task object. (suggested by Martin Fowler)
145
+ * Added ruby_opts to the test task to allow arbitrary ruby options to
146
+ be passed to the test script. (Greg Fast)
147
+ * Fixed the test loader to ignore options. (Greg Fast)
148
+ * Moved Task, FileTask, FileCreationTask and RakeApp into the Rake
149
+ module namespace. Old style namespace behavior can be invoked via
150
+ the --classic-namespace option. (requested by Kelly Felkins).
151
+ * GemTask is now sensitive to the gem platform (Masao Mutoh).
152
+ * A non-existing file prerequisite will no longer cause an exception
153
+ (Philipp Neubeck).
154
+ * Multiple prerequisites on Rake rules now allowed (initial patch
155
+ supplied by Stuart Jansen).
156
+
157
+ == Version 0.5.4
158
+
159
+ * Added double quotes to the test runner.
160
+ * Added .svn to default ignore list.
161
+ * Updated FileList#include to support nested arrays and filelists.
162
+
163
+ == Version 0.5.3
164
+
165
+ * Added support for importing Rakefile and other dependencies.
166
+ * Fixed bug so that now rules can chain off of existing tasks as well
167
+ as existing files.
168
+ * Fixed verbose flag bug in the testing task. Shortened some failure
169
+ messages.
170
+ * Make FileUtils methods private at the top level module to avoid
171
+ accidental method leaking into other objects.
172
+ * Added test loader option to test task. "testrb" is no longer the
173
+ default test loader. It is now eating syntax errors that should
174
+ halt the unit tests.
175
+ * Revamped FileList so that it works more like and array (addressed
176
+ flatten bug). Added many tests around file list.
177
+ * Added +ext+ method to both String and FileList.
178
+
179
+ == Version 0.5.0
180
+
181
+ * Fixed documentation that was lacking the Rake module name (Tilman
182
+ Sauerbeck).
183
+ * Added tar.gz and tar.bz2 support to package task (Tilman Sauerbeck).
184
+ * Recursive rules are now supported (Tilman Sauerbeck).
185
+ * Added warning option for the Test Task (requested by Eric Hodel).
186
+ * The jamis rdoc template is only used if it exists.
187
+ * Added fix for Ruby 1.8.2 test/unit and rails problem.
188
+ * Added contributed rake man file (Jani Monoses).
189
+ * Added Brian Candler's fix for problems in --trace and --dry-run
190
+ mode.
191
+
192
+ == Version 0.4.15
193
+
194
+ * Fixed a bug that prevented the TESTOPTS flag from working with the
195
+ revised for 1.8.2 test task.
196
+ * Updated the docs on --trace to indicate that it also enables a full
197
+ backtrace on errors.
198
+
199
+ == Version 0.4.14
200
+
201
+ * Modified the TestTask to workaround the Ruby 1.8.2 change in
202
+ autoexecuting unit tests.
203
+
204
+ == Version 0.4.13
205
+
206
+ * Fixed the dry-run flag so it is operating again.
207
+ * Multiple arguments to sh and ruby commands will not be interpreted
208
+ by the shell (patch provided by Jonathan Paisley).
209
+
210
+ == Version 0.4.12
211
+
212
+ * Added --silent (-s) to suppress the (in directory) rake message.
213
+
214
+ == Version 0.4.11
215
+
216
+ * Changed the "don't know how to rake" message (finally)
217
+ * Changes references to a literal "Rakefile" to reference the global
218
+ variable $rakefile (which contains the actual name of the rakefile).
219
+
220
+ == Version 0.4.10
221
+
222
+ * Added block support to the "sh" command, allowing users to take
223
+ special actions on the result of the system call. E.g.
224
+
225
+ sh "shell_command" do |ok, res|
226
+ puts "Program returned #{res.exitstatus}" if ! ok
227
+ end
228
+
229
+ == Version 0.4.9
230
+
231
+ * Switched to Jamis Buck's RDoc template.
232
+ * Removed autorequire from Rake's gem spec. This prevents the Rake
233
+ libraries from loading while using rails.
234
+
235
+ == Version 0.4.8
236
+
237
+ * Added support for .rb versions of Rakefile.
238
+ * Removed \\\n's from test task.
239
+ * Fixed Ruby 1.9 compatibility issue with FileList.
240
+
241
+ == Version 0.4.7
242
+
243
+ * Fixed problem in FileList that caused Ruby 1.9 to go into infinite
244
+ recursion. Since to_a was removed from Object, it does not need to
245
+ added back into the list of methods to rewrite in FileList. (Thanks
246
+ to Kent Sibilev for pointing this out).
247
+
248
+ == Version 0.4.6
249
+ * Removed test version of ln in FileUtils that prevented safe_ln from
250
+ using ln.
251
+
252
+ == Version 0.4.5
253
+ * Upgraded comments in TestTask.
254
+ * FileList to_s and inspect now automatically resolve pending changes.
255
+ * FileList#exclude properly returns the FileList.
256
+
257
+ == Version 0.4.4
258
+ * Fixed initialization problem with @comment.
259
+ * Now using multi -r technique in TestTask. Switch Rakefile back to
260
+ using the built-in test task macros because the rake runtime is no
261
+ longer needed.
262
+ * Added 'TEST=filename' and 'TESTOPTS=options' to the Test Task
263
+ macros.
264
+ * Allow a +test_files+ attribute in test tasks. This allows more
265
+ flexibility in specifying test files.
266
+
267
+ == Version 0.4.3
268
+ * Fixed Comment leakage.
269
+
270
+ == Version 0.4.2
271
+ * Added safe_ln that falls back to a copy if a file link is not supported.
272
+ * Package builder now uses safe_ln.
273
+
274
+ == Version 0.4.1
275
+ * Task comments are now additive, combined with "/".
276
+ * Works with (soon to be released) rubygems 0.6.2 (or 0.7.0)
277
+
278
+ == Version 0.4.0
279
+ * FileList now uses deferred loading. The file system is not searched
280
+ until the first call that needs the file names.
281
+ * VAR=VALUE options are now accepted on the command line and are
282
+ treated like environment variables. The values may be tested in a
283
+ Rakefile by referencing ENV['VAR'].
284
+ * File.mtime is now used (instead of File.new().mtime).
285
+
286
+ == Version 0.3.2.x
287
+
288
+ * Removed some hidden dependencies on rubygems. Tests now will test
289
+ gems only if they are installed.
290
+ * Removed Sys from some example files. I believe that is that last
291
+ reference to Sys outside of the contrib area.
292
+ * Updated all copyright notices to include 2004.
293
+
294
+ == Version 0.3.2
295
+
296
+ * GEM Installation now works with the application stub.
297
+
298
+ == Version 0.3.1
299
+
300
+ * FileLists now automatically ignore CVS, .bak, !
301
+ * GEM Installation now works.
302
+
303
+ == Version 0.3.0
304
+
305
+ Promoted 0.2.10.
306
+
307
+ == Version 0.2.10
308
+ General
309
+
310
+ * Added title to Rake's rdocs
311
+ * Contrib packages are no longer included in the documentation.
312
+
313
+ RDoc Issues
314
+
315
+ * Removed default for the '--main' option
316
+ * Fixed rendering of the rdoc options
317
+ * Fixed clean/clobber confusion with rerdoc
318
+ * 'title' attribute added
319
+
320
+ Package Task Library Issues
321
+
322
+ * Version (or explicit :noversion) is required.
323
+ * +package_file+ attribute is now writable
324
+
325
+ FileList Issues
326
+
327
+ * Dropped bang version of exclude. Now using ant-like include/exclude semantics.
328
+ * Enabled the "yield self" idiom in FileList#initialize.
329
+
330
+ == Version 0.2.9
331
+
332
+ This version contains numerous changes as the RubyConf.new(2003)
333
+ presentation was being prepared. The changes include:
334
+
335
+ * The monolithic rubyapp task library is in the process of being
336
+ dropped in favor of lighter weight task libraries.
337
+
338
+ == Version 0.2.7
339
+
340
+ * Added "desc" for task descriptions.
341
+ * -T will now display tasks with descriptions.
342
+ * -P will display tasks and prerequisites.
343
+ * Dropped the Sys module in favor of the 1.8.x FileUtils module. Sys
344
+ is still supported in the contrib area.
345
+
346
+ == Version 0.2.6
347
+
348
+ * Moved to RubyForge
349
+
350
+ == Version 0.2.5
351
+
352
+ * Switched to standard ruby app builder.
353
+ * Added no_match option to file matcher.
354
+
355
+ == Version 0.2.4
356
+
357
+ * Fixed indir, which neglected to actually change directories.
358
+
359
+ == Version 0.2.3
360
+
361
+ * Added rake module for a help target
362
+ * Added 'for_files' to Sys
363
+ * Added a $rakefile constant
364
+ * Added test for selecting proper rule with multiple targets.
data/MIT-LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ Copyright (c) 2003, 2004 Jim Weirich
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21
+
data/README ADDED
@@ -0,0 +1,242 @@
1
+ = RAKE -- Ruby Make
2
+
3
+ Supporting Rake version: 0.7.x
4
+
5
+ This package contains Rake, a simple ruby build program with
6
+ capabilities similar to make.
7
+
8
+ Rake has the following features:
9
+
10
+ * Rakefiles (rake's version of Makefiles) are completely defined in
11
+ standard Ruby syntax. No XML files to edit. No quirky Makefile
12
+ syntax to worry about (is that a tab or a space?)
13
+
14
+ * Users can specify tasks with prerequisites.
15
+
16
+ * Rake supports rule patterns to synthesize implicit tasks.
17
+
18
+ * Flexible FileLists that act like arrays but know about manipulating
19
+ file names and paths.
20
+
21
+ * A library of prepackaged tasks to make building rakefiles easier.
22
+
23
+ == Download
24
+
25
+ The latest version of rake can be found at
26
+
27
+ * http://rubyforge.org/project/showfiles.php?group_id=50
28
+
29
+ == Installation
30
+
31
+ === Normal Installation
32
+
33
+ You can install rake with the following command.
34
+
35
+ % ruby install.rb
36
+
37
+ from its distribution directory.
38
+
39
+ === GEM Installation
40
+
41
+ Download and install rake with the following.
42
+
43
+ gem install --remote rake
44
+
45
+ === Running the Rake Test Suite
46
+
47
+ If you wish to run the unit and functional tests that come with Rake:
48
+
49
+ * CD into the top project directory of rake.
50
+ * Type one of the following:
51
+
52
+ rake # If you have a version of rake installed
53
+ ruby -Ilib bin/rake # If you do not have a version of rake installed.
54
+
55
+ == Online Resources
56
+
57
+ == Rake References
58
+
59
+ * Rake Documentation Home: http://docs.rubyrake.org
60
+ * Rake Project Page: http://rubyforge.org/projects/rake
61
+ * Rake API Documents: http://rake.rubyforge.org
62
+ * Rake Source Code Repo: http://github.com/jimweirich/rake
63
+
64
+ == Presentations and Articles about Rake
65
+
66
+ * Jim Weirich's 2003 RubyConf presentation: http://onestepback.org/articles/buildingwithrake/
67
+ * Martin Fowler's article on Rake: http://martinfowler.com/articles/rake.html
68
+
69
+ === Road Map
70
+
71
+ * If you want to see how to invoke rake to build your projects, read on.
72
+ * If you want to see the format of a Rakefile, see
73
+ doc/rakefile.rdoc[http://rake.rubyforge.org/files/doc/rakefile_rdoc.html].
74
+ * If you want to see the original announcement of rake, see
75
+ doc/rational.rdoc[http://rake.rubyforge.org/files/doc/rational_rdoc.html].
76
+ * If you want to see a glossary of terms, see
77
+ doc/glossary.rdoc[http://rake.rubyforge.org/files/doc/glossary_rdoc.html].
78
+
79
+ == Simple Example
80
+
81
+ Once installed, you can run rake as follows ...
82
+
83
+ % rake [options ...] [VAR=VALUE ...] [tasks...]
84
+
85
+ Type "rake --help" for an up-to-date option summary.
86
+
87
+ Invoking <tt>rake</tt> without any options or targets causes rake to
88
+ look for a rakefile and invoke the default task in that rakefile.
89
+
90
+ For example, given a simple rakefile like this ...
91
+
92
+ task :default => [:test]
93
+
94
+ task :test do
95
+ ruby "test/unittest.rb"
96
+ end
97
+
98
+ The command
99
+
100
+ $ rake
101
+
102
+ will invoke the +default+ task. As +default+ satisfies its
103
+ prerequisites, the +test+ task will run the unit tests for the
104
+ package.
105
+
106
+ == Other Make Reinvisionings ...
107
+
108
+ Rake is a late entry in the make replacement field. Here are links to
109
+ other projects with similar (and not so similar) goals.
110
+
111
+ * http://directory.fsf.org/bras.html -- Bras, one of earliest
112
+ implementations of "make in a scripting language".
113
+ * http://www.a-a-p.org -- Make in Python
114
+ * http://www.aromatic.com/tools/jam.txt -- JAM, Java Automated Make
115
+ * http://ant.apache.org -- The Ant project
116
+ * http://ppt.perl.org/commands/make/index.html -- Make from the Perl
117
+ Power Tools implementation.
118
+ * http://search.cpan.org/search?query=PerlBuildSystem -- The Perl Build System
119
+ * http://make.rubyforge.org -- Rant, another Ruby make tool.
120
+
121
+ == Credits
122
+
123
+ [<b>Ryan Dlugosz</b>] For the initial conversation that sparked Rake.
124
+
125
+ [<b>nobu.nokada@softhome.net</b>] For the initial patch for rule support.
126
+
127
+ [<b>Tilman Sauerbeck <tilman@code-monkey.de></b>] For the recursive rule patch.
128
+
129
+ == License
130
+
131
+ Rake is available under an MIT-style license.
132
+
133
+ :include: MIT-LICENSE
134
+
135
+ == Support
136
+
137
+ The Rake homepage is http://rake.rubyforge.org. You can find the Rake
138
+ RubyForge page at http://rubyforge.org/projects/rake.
139
+
140
+ Feel free to submit commits or feature requests. If you send a patch,
141
+ remember to update the corresponding unit tests. If fact, I prefer
142
+ new feature to be submitted in the form of new unit tests.
143
+
144
+ For other information, feel free to ask on the ruby-talk mailing list
145
+ (which is mirrored to comp.lang.ruby) or contact
146
+ mailto:jim@weirichhouse.org.
147
+
148
+ ----
149
+
150
+ = Usage
151
+
152
+ Rake is invoked from the command line using:
153
+
154
+ % rake [<em>options</em> ...] [<em>VAR</em>=<em>VALUE</em>] [<em>targets</em> ...]
155
+
156
+ Options are:
157
+
158
+ [<tt><em>name</em>=<em>value</em></tt>]
159
+ Set the environment variable <em>name</em> to <em>value</em>
160
+ during the execution of the <b>rake</b> command. You can access
161
+ the value by using ENV['<em>name</em>'].
162
+
163
+ [<tt>--classic-namespace</tt> (-n)]
164
+ Import the Task, FileTask, and FileCreateTask into the top-level
165
+ scope to be compatible with older versions of Rake. Alternatively
166
+ you can include the line <code>require
167
+ 'rake/classic_namespace'</code> in your Rakefile to get the
168
+ classic behavior.
169
+
170
+ [<tt>--dry-run</tt> (-n)]
171
+ Do a dry run. Print the tasks invoked and executed, but do not
172
+ actually execute any of the actions.
173
+
174
+ [<tt>--help</tt> (-H)]
175
+ Display some help text and exit.
176
+
177
+ [<tt>--libdir</tt> _directory_ (-I)]
178
+ Add _directory_ to the list of directories searched for require.
179
+
180
+ [<tt>--nosearch</tt> (-N)]
181
+ Do not search for a Rakefile in parent directories.
182
+
183
+ [<tt>--prereqs</tt> (-P)]
184
+ Display a list of all tasks and their immediate prerequisites.
185
+
186
+ [<tt>--quiet</tt> (-q)]
187
+ Do not echo commands from FileUtils.
188
+
189
+ [<tt>--rakefile</tt> _filename_ (-f)]
190
+ Use _filename_ as the name of the rakefile. The default rakefile
191
+ names are +rakefile+ and +Rakefile+ (with +rakefile+ taking
192
+ precedence). If the rakefile is not found in the current
193
+ directory, +rake+ will search parent directories for a match. The
194
+ directory where the Rakefile is found will become the current
195
+ directory for the actions executed in the Rakefile.
196
+
197
+ [<tt>--require</tt> _name_ (-r)]
198
+ Require _name_ before executing the Rakefile.
199
+
200
+ [<tt>--tasks</tt> (-T)]
201
+ Display a list of the major tasks and their comments. Comments
202
+ are defined using the "desc" command.
203
+
204
+ [<tt>--trace</tt> (-t)]
205
+ Turn on invoke/execute tracing. Also enable full backtrace on errors.
206
+
207
+ [<tt>--usage</tt> (-h)]
208
+ Display a usage message and exit.
209
+
210
+ [<tt>--verbose</tt> (-v)]
211
+ Echo the Sys commands to standard output.
212
+
213
+ [<tt>--version</tt> (-V)]
214
+ Display the program version and exit.
215
+
216
+ In addition, any command line option of the form
217
+ <em>VAR</em>=<em>VALUE</em> will be added to the environment hash
218
+ <tt>ENV</tt> and may be tested in the Rakefile.
219
+
220
+ ---
221
+
222
+ = Rakefile Format
223
+
224
+ See doc/rakefile.rdoc[http://rake.rubyforge.org/files/doc/rakefile_rdoc.html]
225
+ for details on the Rakefile format.
226
+
227
+ ---
228
+
229
+ = Other stuff
230
+
231
+ Author:: Jim Weirich <jim@weirichhouse.org>
232
+ Requires:: Ruby 1.8.0 or later
233
+ License:: Copyright 2003, 2004 by Jim Weirich.
234
+ Released under an MIT-style license. See the LICENSE file
235
+ included in the distribution.
236
+
237
+ == Warranty
238
+
239
+ This software is provided "as is" and without any express or
240
+ implied warranties, including, without limitation, the implied
241
+ warranties of merchantibility and fitness for a particular
242
+ purpose.