diff options
| author | mattinger <[email protected]> | 2006-08-09 17:48:45 +0000 |
|---|---|---|
| committer | mattinger <[email protected]> | 2006-08-09 17:48:45 +0000 |
| commit | 98eee0fff40d077d73319ceaa7ae9bdaf3c71d70 (patch) | |
| tree | 8ad62204756eae5c544e31dc8b2e7c25109f99f3 /docs | |
| parent | 0058b0ff2af01ec8ae2a0f28993ad691d873e682 (diff) | |
Adding relentless task
git-svn-id: file:///home/sven/projects/JOGL/temp/ant-contrib/svn/ant-contrib-code/trunk/ant-contrib@12 32d7a393-a5a9-423c-abd3-5d954feb1f2f
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/manual/tasks/relentless.html | 141 | ||||
| -rw-r--r-- | docs/manual/tasks/toc.html | 1 |
2 files changed, 142 insertions, 0 deletions
diff --git a/docs/manual/tasks/relentless.html b/docs/manual/tasks/relentless.html new file mode 100644 index 0000000..b30be41 --- /dev/null +++ b/docs/manual/tasks/relentless.html @@ -0,0 +1,141 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <title>Ant-contrib Tasks: Relentless</title> + </head> + + <body> + <h1>Relentless</h1> + + <p>The <relentless> task will execute all of the + nested tasks, regardless of whether one or more of the + nested tasks fails. When <relentless> has completed + executing the nested tasks, it will either + <ul> + <li>fail, if any one or more of the nested tasks failed; or + <li>succeed, if all of the nested tasks succeeded. + </ul> + An appropriate message will be written to the log. + </p> + <P> + Tasks are executed in the order that they appear within the + <relentless> task. It is up to the user to ensure that + relentless execution of the + nested tasks is safe. + </p> + <p><em> + This task only works for ant version greater than or equal + to ant 1.6.0. + </em> + </p> + + <h2>Parameters</h2> + <table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Description</th> + <th>Required</th> + </tr> + <tr> + <td valign="top">description</td> + <td valign="top">A string that will be included in the log output. This + can be useful for helping to identify sections of large Ant builds.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">terse</td> + <td valign="top">Setting this to <code>true</code> will eliminate some of the progress + output generated by <relentless>. This can reduce clutter in some + cases. The default value is <code>false</code>.</td> + <td align="center" valign="top">No</td> + </tr> + </table> + + <h2>Nested elements</h2> + + <h3>task list</h3> + + <p> + The only nested element supported by <relentless> is a list of tasks + to be executed. At least one task must be specified. + </p> + <P> + It is important to note that <relentless> only proceeds relentlessly + from one task to the next - it does <b>not</b> apply recursively to any tasks + that might be invoked by these + nested tasks. If a nested task invokes some other list of tasks (perhaps + by <antcall> for example), and one of those other tasks fails, then the + nested task will stop at that point. + </p> + + <h3>Example</h3> + <p> + A relentless task to print out the first five canonical variable names: + <blockquote> + <pre><relentless description="The first five canonical variable names."> + <echo>foo</echo> + <echo>bar</echo> + <echo>baz</echo> + <echo>bat</echo> + <echo>blah</echo> +</relentless></pre> + </blockquote> + which should produce output looking more or less like + <blockquote> + <pre>[relentless] Relentlessly executing: The first five canonical variable names. +[relentless] Executing: task 1 + [echo] foo +[relentless] Executing: task 2 + [echo] bar +[relentless] Executing: task 3 + [echo] baz +[relentless] Executing: task 4 + [echo] bat +[relentless] Executing: task 5 + [echo] blah +[relentless] All tasks completed successfully.</pre> + </blockquote> + </p> + If you change the first line to set the <code>terse</code> parameter, + <pre> <relentless terse="true" description="The first five canonical variable names."/></pre>the + output will look more like this: + <blockquote> + <pre>[relentless] Relentlessly executing: The first five canonical variable names. + [echo] foo + [echo] bar + [echo] baz + [echo] bat + [echo] blah +[relentless] All tasks completed successfully.</pre> + </blockquote> + </p> + <p> + If we change the third task to deliberately fail + <blockquote> + <pre><relentless terse="true" description="The first five canonical variable names."> + <echo>foo</echo> + <echo>bar</echo> + <fail>baz</fail> + <echo>bat</echo> + <echo>blah</echo> +</relentless></pre> + </blockquote> + then the output should look something like this. + <blockquote> + <pre>[relentless] Relentlessly executing: The first five canonical variable names. + [echo] foo + [echo] bar +[relentless] Task task 3 failed: baz + [echo] bat + [echo] blah + +BUILD FAILED +/home/richter/firmware/sensor/build.xml:1177: Relentless execution: 1 of 5 tasks failed.</pre> + </blockquote> + </p> + <hr> + <p align="center">Copyright © 2005 Ant-Contrib Project. All + rights Reserved.</p> + + </body> +</html> diff --git a/docs/manual/tasks/toc.html b/docs/manual/tasks/toc.html index b1d926f..df60d23 100644 --- a/docs/manual/tasks/toc.html +++ b/docs/manual/tasks/toc.html @@ -14,6 +14,7 @@ <li><a href="for.html" target="mainFrame">For</a></li> <li><a href="if.html" target="mainFrame">If</a></li> <li><a href="outofdate.html" target="mainFrame">Outoutdate</a></li> + <li><a href="relentless.html" target="mainFrame">Relentless</a></li> <li><a href="runtarget.html" target="mainFrame">RunTarget</a></li> <li><a href="switch.html" target="mainFrame">Switch</a></li> <li><a href="throw.html" target="mainFrame">Throw</a></li> |