glossary.rdoc 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. = Glossary
  2. [<b>action</b>]
  3. Code to be executed in order to perform a task. Actions in a
  4. rakefile are specified in a code block (usually delimited by
  5. +do+/+end+ pairs.
  6. [<b>execute</b>]
  7. When a task is executed, all of its actions are performed, in
  8. the order they were defined. Note that unlike
  9. <tt>invoke</tt>, <tt>execute</tt> always executes the actions
  10. (without invoking or executing the prerequisites).
  11. [<b>file task</b> (FileTask)]
  12. A file task is a task whose purpose is to create a file
  13. (which has the same name as the task). When invoked, a file
  14. task will only execute if one or more of the following
  15. conditions are true.
  16. 1. The associated file does not exist.
  17. 2. A prerequisite has a later time stamp than the existing file.
  18. Because normal Tasks always have the current time as
  19. timestamp, a FileTask that has a normal Task prerequisite
  20. will always execute.
  21. [<b>invoke</b>]
  22. When a task is invoked, first we check to see if it has been
  23. invoked before. if it has been, then nothing else is done.
  24. If this is the first time its been invoked, then we invoke
  25. each of its prerequisites. Finally, we check to see if we
  26. need to execute the actions of this task by calling
  27. <tt>needed?</tt>. Finally, if the task is needed, we execute
  28. its actions.
  29. NOTE: Currently prerequisites are invoked even if the task is
  30. not needed. This may change in the future.
  31. [<b>prerequisites</b>]
  32. Every task has a set (possibly empty) of prerequisites. A
  33. prerequisite P to Task T is itself a task that must be invoked
  34. before Task T.
  35. [<b>rule</b>]
  36. A rule is a recipe for synthesizing a task when no task is
  37. explicitly defined. Rules generally synthesize file tasks.
  38. [<b>task</b> (Task)]
  39. Basic unit of work in a rakefile. A task has a name, a set of
  40. prerequisites and a list of actions to be performed.