92 lines
4.0 KiB
HTML
92 lines
4.0 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
|||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|||
|
|
<!-- Documenting T:NAnt.Core.Tasks.IncludeTask-->
|
|||
|
|
<head>
|
|||
|
|
<meta http-equiv="Content-Language" content="en-ca" />
|
|||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../style.css" />
|
|||
|
|
<title><include> Task</title>
|
|||
|
|
</head>
|
|||
|
|
<body>
|
|||
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
|
|||
|
|
<tr>
|
|||
|
|
<td class="NavBar-Cell">
|
|||
|
|
<a href="http://nant.sourceforge.net">
|
|||
|
|
<b>NAnt</b>
|
|||
|
|
</a>
|
|||
|
|
<img alt="->" src="../images/arrow.gif" />
|
|||
|
|
<a href="../index.html">Help</a>
|
|||
|
|
<img alt="->" src="../images/arrow.gif" />
|
|||
|
|
<a href="../tasks/index.html">Task Reference</a>
|
|||
|
|
<img alt="->" src="../images/arrow.gif" /> <include></td>
|
|||
|
|
<td class="NavBar-Cell" align="right">
|
|||
|
|
v0.91</td>
|
|||
|
|
</tr>
|
|||
|
|
</table>
|
|||
|
|
<h1><include></h1>
|
|||
|
|
<p> Includes an external build file. </p>
|
|||
|
|
<p> This task is used to break your build file into smaller chunks. You can load a partial build file and have it included into the build file. </p>
|
|||
|
|
<p class="i2">
|
|||
|
|
<b>Note:</b> Any global (project level) tasks in the included build file are executed when this task is executed. Tasks in target elements are only executed if that target is executed. </p>
|
|||
|
|
<p class="i2">
|
|||
|
|
<b>Note:</b> The project element attributes are ignored. </p>
|
|||
|
|
<p class="i2">
|
|||
|
|
<b>Note:</b> This task can only be in the global (project level) section of the build file. </p>
|
|||
|
|
<p class="i2">
|
|||
|
|
<b>Note:</b> This task can only include files from the file system. </p>
|
|||
|
|
<h3>Parameters</h3>
|
|||
|
|
<div class="table">
|
|||
|
|
<table>
|
|||
|
|
<tr>
|
|||
|
|
<th>Attribute</th>
|
|||
|
|
<th style="text-align: center;">Type</th>
|
|||
|
|
<th>Description</th>
|
|||
|
|
<th style="text-align: center;">Required</th>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top" class="required">buildfile</td>
|
|||
|
|
<td style="text-align: center;">string</td>
|
|||
|
|
<td> Build file to include. </td>
|
|||
|
|
<td style="text-align: center;">True</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">failonerror</td>
|
|||
|
|
<td style="text-align: center;">bool</td>
|
|||
|
|
<td> Determines if task failure stops the build, or is just reported. The default is <b>true</b>. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">if</td>
|
|||
|
|
<td style="text-align: center;">bool</td>
|
|||
|
|
<td> If <b>true</b> then the task will be executed; otherwise, skipped. The default is <b>true</b>. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">unless</td>
|
|||
|
|
<td style="text-align: center;">bool</td>
|
|||
|
|
<td> Opposite of <code>if</code>. If <b>false</b> then the task will be executed; otherwise, skipped. The default is <b>false</b>. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">verbose</td>
|
|||
|
|
<td style="text-align: center;">bool</td>
|
|||
|
|
<td> Determines whether the task should report detailed build log messages. The default is <b>false</b>. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
</table>
|
|||
|
|
</div>
|
|||
|
|
<h3>Examples</h3>
|
|||
|
|
<ul class="examples">
|
|||
|
|
<li>
|
|||
|
|
<p> Include a task that fetches the project version from the <code>GetProjectVersion.include</code> build file. </p>
|
|||
|
|
<pre class="code">
|
|||
|
|
<include buildfile="GetProjectVersion.include" />
|
|||
|
|
</pre>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<h3>Requirements</h3>
|
|||
|
|
<div style="margin-left: 20px;">
|
|||
|
|
<b>Assembly:</b> NAnt.Core (0.91.4312.0)
|
|||
|
|
</div>
|
|||
|
|
</body>
|
|||
|
|
</html>
|