/Trunk/NSsh/Dependencies/nant/doc/help/fundamentals/tasks.html

# · HTML · 274 lines · 273 code · 1 blank · 0 comment · 0 complexity · 1612fcb11ab709e4cf85de53cde5749d MD5 · raw file 

    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">

    3. 

  3.     <head>

    4. 

  4.         <meta http-equiv="Content-Language" content="en-ca" />

    5. 

  5.         <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

    6. 

  6.         <meta name="description" content="Tasks" />

    7. 

  7.         <link rel="stylesheet" type="text/css" href="../style.css" />

    8. 

  8.         <title>Tasks</title>

    9. 

  9.     </head>

    10. 

  10.     <body>

    11. 

  11.         <table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">

    12. 

  12.             <tr>

    13. 

  13.                 <td class="NavBar-Cell">

    14. 

  14.                     <a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a>

    15. 

  15.                     <img src="../images/arrow.gif" alt="-&gt;" width="13" height="9" />

    16. 

  16.                     <a href="../index.html">Help</a>

    17. 

  17.                     <img alt="-&gt;" src="../images/arrow.gif" />

    18. 

  18.                     <a href="index.html">Fundamentals</a>

    19. 

  19.                     <img height="9" alt="-&gt;" src="../images/arrow.gif" width="13" />

    20. 

  20.                     Tasks

    21. 

  21.                 </td>

    22. 

  22.                 <td class="NavBar-Cell" align="right">

    23. 

  23.                     v0.85

    24. 

  24.                 </td>

    25. 

  25.             </tr>

    26. 

  26.         </table>

    27. 

  27.         <h1>Tasks</h1>

    28. 

  28.         

    29. 

  29.         <h2><a id="contents" />Contents</h2>

    30. 

  30.         <div>

    31. 

  31.             1 <a href="#introduction">Introduction</a><br />

    32. 

  32.             2 <a href="#taskloader">Loading custom extensions</a><br />

    33. 

  33.             <div style="margin-left: 20px;">

    34. 

  34.                 2.1 <a href="#taskloader-automatic">Automatic discovery</a><br/>

    35. 

  35.                 <div style="margin-left: 20px;">

    36. 

  36.                     2.1.1 <a href="#automatic-os">Operating system</a><br/>

    37. 

  37.                     2.1.2 <a href="#automatic-runtime">Runtime framework</a><br/>

    38. 

  38.                     2.1.3 <a href="#automatic-project">Project</a><br/>

    39. 

  39.                 </div>

    40. 

  40.                 2.2 <a href="#taskloader-forced">Forced scan</a><br/>

    41. 

  41.             </div>

    42. 

  42.         </div>

    43. 

  43.         <h2><a id="introduction" />1 Introduction</h2>

    44. 

  44.         <p>A task is a piece of code that can be executed.</p>

    45. 

  45.         <p>A task can have multiple attributes (or arguments, if you prefer).&nbsp; The 

    46. 

  46.             value of an attribute may contain references to a <a href="properties.html">property</a>.&nbsp; 

    47. 

  47.             These references will be resolved before the task is executed.</p>

    48. 

  48.         <p>Tasks have a common structure:</p>

    49. 

  49.         <blockquote><pre>&lt;<i>name</i> <i>attribute1</i>="<i>value1</i>" <i>attribute2</i>="<i>value2</i>" ... /&gt;</pre>

    50. 

  50.         </blockquote>

    51. 

  51.         <p>where <i>name</i> is the name of the task, <i>attribute#</i> is the attribute 

    52. 

  52.             name, and <i>value#</i> is the value for this attribute.</p>

    53. 

  53.         <p><img height="9" alt=">" src="../images/bullet.gif" width="5" />&nbsp;For 

    54. 

  54.             more information see the <a href="../tasks/index.html">Task Reference</a>.</p>

    55. 

  55.         <h2><a id="taskloader" />2 Loading custom extensions</h2>

    56. 

  56.         <p>

    57. 

  57.             Extensions can be devided in the following categories:

    58. 

  58.         </p>

    59. 

  59.         <ul>

    60. 

  60.             <li>Tasks</li>

    61. 

  61.             <li>Filters</li>

    62. 

  62.             <li>Functions</li>

    63. 

  63.             <li>Global Types</li>

    64. 

  64.         </ul>

    65. 

  65.         <p>

    66. 

  66.             NAnt currently provides two mechanisms to make third-party extensions available for use in build scripts:

    67. 

  67.         </p>

    68. 

  68.         <ul>

    69. 

  69.             <li>

    70. 

  70.                 Automatic discovery

    71. 

  71.             </li>

    72. 

  72.             <li>

    73. 

  73.                 Forced scan

    74. 

  74.             </li>

    75. 

  75.         </ul>

    76. 

  76.         <p>

    77. 

  77.             Both mechanisms use .NET reflection to scan one or more assemblies for the presence of extensions. When found,

    78. 

  78.             these extensions are registered in the NAnt type system, and from then on these are available for all build 

    79. 

  79.             scripts (in the current NAnt instance).

    80. 

  80.         </p>

    81. 

  81.         <h3><a id="taskloader-automatic" />2.1 Automatic discovery</h3>

    82. 

  82.         <p>

    83. 

  83.             To facilitate registration of extensions that are used in multiple (or even all) build 

    84. 

  84.             scripts, NAnt supports automatic discovery of extensions.

    85. 

  85.         </p>

    86. 

  86.         <p>

    87. 

  87.             In this context, automatic discovery means scanning a predefined set of directories and files for extensions.

    88. 

  88.         </p>

    89. 

  89.         <p>

    90. 

  90.             The actual set of directories and files that is scanned is determined by:

    91. 

  91.         </p>

    92. 

  92.         <ul>

    93. 

  93.             <li>Operating system</li>

    94. 

  94.             <li>Runtime framework</li>

    95. 

  95.             <li>Project</li>

    96. 

  96.         </ul>

    97. 

  97.         <h4><a id="automatic-os" />2.1.1 Operating system</h4>

    98. 

  98.         <p>

    99. 

  99.             When starting NAnt, all assemblies matching the following patterns will be scanned for extensions:

    100. 

  100.         </p>

    101. 

  101.         <div style="margin-left: 20px;">

    102. 

  102.             <p>

    103. 

  103.             <b>Windows</b>

    104. 

  104.             </p>

    105. 

  105.             <div style="margin-left: 20px;">

    106. 

  106.                 <table style="width: 800px;" cellspacing="1" cellpadding="4">

    107. 

  107.                     <colgroup>

    108. 

  108.                         <col style="text-align: center;" />

    109. 

  109.                         <col style="text-align: center;" />

    110. 

  110.                         <col style="text-align: left;" />

    111. 

  111.                     </colgroup>

    112. 

  112.                     <tr>

    113. 

  113.                         <th>Pattern</th>

    114. 

  114.                         <th>Action</th>

    115. 

  115.                         <th>Description</th>

    116. 

  116.                     </tr>

    117. 

  117.                     <tr>

    118. 

  118.                         <td colspan="3"><hr /></td>

    119. 

  119.                     </tr>

    120. 

  120.                     <tr>

    121. 

  121.                         <td>*Tasks.dll</td>

    122. 

  122.                         <td>include</td>

    123. 

  123.                         <td>NAnt Core assemblies</td>

    124. 

  124.                     </tr>

    125. 

  125.                     <tr>

    126. 

  126.                         <td>*Tests.dll</td>

    127. 

  127.                         <td>include</td>

    128. 

  128.                         <td>NAnt test assemblies</td>

    129. 

  129.                     </tr>

    130. 

  130.                     <tr>

    131. 

  131.                         <td>tasks/*.dll</td>

    132. 

  132.                         <td>include</td>

    133. 

  133.                         <td>Framework-neutral assemblies</td>

    134. 

  134.                     </tr>

    135. 

  135.                     <tr>

    136. 

  136.                         <td>NAnt.MSNetTasks.dll</td>

    137. 

  137.                         <td>exclude</td>

    138. 

  138.                         <td>Microsoft.NET specific assembly</td>

    139. 

  139.                     </tr>

    140. 

  140.                     <tr>

    141. 

  141.                         <td>NAnt.MSNet.Tests.dll</td>

    142. 

  142.                         <td>exclude</td>

    143. 

  143.                         <td>Microsoft.NET specific test assembly</td>

    144. 

  144.                     </tr>

    145. 

  145.                 </table>

    146. 

  146.             </div>

    147. 

  147.         </div>

    148. 

  148.         <div style="margin-left: 20px;">

    149. 

  149.             <p>

    150. 

  150.             <b>Unix</b>

    151. 

  151.             </p>

    152. 

  152.             <div style="margin-left: 20px;">

    153. 

  153.                 <table style="width: 800px;" cellspacing="1" cellpadding="4">

    154. 

  154.                     <colgroup>

    155. 

  155.                         <col style="text-align: center;" />

    156. 

  156.                         <col style="text-align: center;" />

    157. 

  157.                         <col style="text-align: left;" />

    158. 

  158.                     </colgroup>

    159. 

  159.                     <tr>

    160. 

  160.                         <th>Pattern</th>

    161. 

  161.                         <th>Action</th>

    162. 

  162.                         <th style="text-align: left;">Description</th>

    163. 

  163.                     </tr>

    164. 

  164.                     <tr>

    165. 

  165.                         <td colspan="3"><hr /></td>

    166. 

  166.                     </tr>

    167. 

  167.                     <tr>

    168. 

  168.                         <td>*Tasks.dll</td>

    169. 

  169.                         <td>include</td>

    170. 

  170.                         <td>NAnt Core assemblies</td>

    171. 

  171.                     </tr>

    172. 

  172.                     <tr>

    173. 

  173.                         <td>*Tests.dll</td>

    174. 

  174.                         <td>include</td>

    175. 

  175.                         <td>NAnt test assemblies</td>

    176. 

  176.                     </tr>

    177. 

  177.                     <tr>

    178. 

  178.                         <td>tasks/*.dll</td>

    179. 

  179.                         <td>include</td>

    180. 

  180.                         <td>Framework-neutral assemblies</td>

    181. 

  181.                     </tr>

    182. 

  182.                     <tr>

    183. 

  183.                         <td>NAnt.MSNetTasks.dll</td>

    184. 

  184.                         <td>exclude</td>

    185. 

  185.                         <td>Microsoft.NET specific assembly</td>

    186. 

  186.                     </tr>

    187. 

  187.                     <tr>

    188. 

  188.                         <td>NAnt.MSNet.Tests.dll</td>

    189. 

  189.                         <td>exclude</td>

    190. 

  190.                         <td>Microsoft.NET specific test assembly</td>

    191. 

  191.                     </tr>

    192. 

  192.                     <tr>

    193. 

  193.                         <td>NAnt.VSNetTasks.dll</td>

    194. 

  194.                         <td>exclude</td>

    195. 

  195.                         <td>Assembly containing <a href="../tasks/solution.html"><code>&lt;solution&gt;</code></a> task</td>

    196. 

  196.                     </tr>

    197. 

  197.                     <tr>

    198. 

  198.                         <td>NAnt.Win32Tasks.dll</td>

    199. 

  199.                         <td>exclude</td>

    200. 

  200.                         <td>Win32 specific assembly</td>

    201. 

  201.                     </tr>

    202. 

  202.                     <tr>

    203. 

  203.                         <td>NAnt.Win32.Tests.dll</td>

    204. 

  204.                         <td>exclude</td>

    205. 

  205.                         <td>Win32 specific test assembly</td>

    206. 

  206.                     </tr>

    207. 

  207.                 </table>

    208. 

  208.             </div>

    209. 

  209.         </div>

    210. 

  210.         <p>

    211. 

  211.             <b>NOTE</b>: all patterns are matched relative to the NAnt base directory, which is the directory in which NAnt.exe is located.

    212. 

  212.         </p>

    213. 

  213.         <h4><a id="automatic-runtime" />2.1.2 Runtime framework</h4>

    214. 

  214.         <p>

    215. 

  215.             Depending on the runtime framework on which NAnt is running, some additional directories are scanned.

    216. 

  216.         </p>

    217. 

  217.         <p>

    218. 

  218.             In general, the following include patterns are applied:

    219. 

  219.         </p>

    220. 

  220.         <div style="margin-left: 20px;">

    221. 

  221.             tasks/&lt;framework family&gt;/*.dll<br/>

    222. 

  222.             tasks/&lt;framework family&gt;/&lt;framework version&gt;/**/*.dll<br/>

    223. 

  223.         </div>

    224. 

  224.         <p>

    225. 

  225.             <b>Example:</b>

    226. 

  226.         </p>

    227. 

  227.         <p>

    228. 

  228.             When running NAnt on Microsoft .NET Framework 1.0, assemblies matching the following pattern would be scanned:

    229. 

  229.         </p>

    230. 

  230.         <div style="margin-left: 20px;">

    231. 

  231.             tasks/net/*.dll<br />

    232. 

  232.             tasks/net/1.0/**/*.dll

    233. 

  233.         </div>

    234. 

  234.         <p>

    235. 

  235.             <b>NOTE:</b> the exact set of patterns that are used for a given runtime framework is defined in the NAnt configuration file (NAnt.exe.config).

    236. 

  236.         </p>

    237. 

  237.         <h4><a id="automatic-project">2.1.3 Project</a></h4>

    238. 

  238.         <p>

    239. 

  239.             Whenever a build project is started, NAnt will scan the following directories for assemblies that match the *.dll pattern:

    240. 

  240.         </p>

    241. 

  241.         <ul>

    242. 

  242.             <li>

    243. 

  243.                 &lt;Project Base Directory&gt;\tasks\

    244. 

  244.             </li>

    245. 

  245.             <li>

    246. 

  246.                 &lt;Project Base Directory&gt;\tasks\&lt;framework family&gt;\

    247. 

  247.             </li>

    248. 

  248.             <li>

    249. 

  249.                 &lt;Project Base Directory&gt;\tasks\&lt;framework family&gt;\&lt;framework version&gt;\

    250. 

  250.             </li>

    251. 

  251.         </ul>

    252. 

  252.         <p>

    253. 

  253.             <b>Example:</b>

    254. 

  254.         </p>

    255. 

  255.         <p>

    256. 

  256.             For a project file located in &quot;c:\projects\log4net&quot; with NAnt running on the Microsoft .NET 2.0 runtime, NAnt would end-up scanning the following project-level directories:

    257. 

  257.         </p>

    258. 

  258.         <ul>

    259. 

  259.             <li>

    260. 

  260.                 c:\projects\log4net\tasks\

    261. 

  261.             </li>

    262. 

  262.             <li>

    263. 

  263.                 c:\projects\log4net\tasks\net\

    264. 

  264.             </li>

    265. 

  265.             <li>

    266. 

  266.                 c:\projects\log4net\tasks\net\2.0\

    267. 

  267.             </li>

    268. 

  268.         </ul>

    269. 

  269.         <h3><a id="taskloader-forced" />2.2 Forced scan</h3>

    270. 

  270.         <p>

    271. 

  271.             To explicitly instruct NAnt to scan a certain assembly (or set of assemblies) for extensions, build authors can use the <a href="../tasks/loadtasks.html"><code>&lt;loadtasks&gt;</code></a> tasks.

    272. 

  272.         </p>

    273. 

  273.     </body>

    274. 

  274. </html>
    275.