Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 52 lines (40 sloc) 1.843 kB
de564de Initial revision
jimweirich authored
1 = Glossary
2
3 [<b>action</b>]
4 Code to be executed in order to perform a task. Actions in a
5 rakefile are specified in a code block (usually delimited by
6 +do+/+end+ pairs.
7
8 [<b>execute</b>]
9 When a task is executed, all of its actions are performed, in
10 the order they were defined. Note that unlike
11 <tt>invoke</tt>, <tt>execute</tt> always executes the actions
12 (without invoking or executing the prerequisites).
13
14 [<b>file task</b> (FileTask)]
15 A file task is a task whose purpose is to create a file
16 (which has the same name as the task). When invoked, a file
17 task will only execute if one or more of the following
18 conditions are true.
19
20 1. The associated file does not exist.
21 2. A prerequisite has a later time stamp than the existing file.
22
23 Because normal Tasks always have the current time as
24 timestamp, a FileTask that has a normal Task prerequisite
25 will always execute.
26
27 [<b>invoke</b>]
28 When a task is invoked, first we check to see if it has been
29 invoked before. if it has been, then nothing else is done.
30 If this is the first time its been invoked, then we invoke
31 each of its prerequisites. Finally, we check to see if we
32 need to execute the actions of this task by calling
33 <tt>needed?</tt>. Finally, if the task is needed, we execute
34 its actions.
35
36 NOTE: Currently prerequisites are invoked even if the task is
37 not needed. This may change in the future.
38
39 [<b>prerequisites</b>]
a81a515 @jimweirich Fixed typo.
authored
40 Every task has a set (possibly empty) of prerequisites. A
de564de Initial revision
jimweirich authored
41 prerequisite P to Task T is itself a task that must be invoked
af62240 @rtlechow Clean up trailing whitespace.
rtlechow authored
42 before Task T.
de564de Initial revision
jimweirich authored
43
44 [<b>rule</b>]
45 A rule is a recipe for synthesizing a task when no task is
46 explicitly defined. Rules generally synthesize file tasks.
47
48 [<b>task</b> (Task)]
49 Basic unit of work in a rakefile. A task has a name, a set of
50 prerequisites and a list of actions to be performed.
51
Something went wrong with that request. Please try again.