~mandel/ubuntuone-windows-installer/fix_null_pointer_start

« back to all changes in this revision

Viewing changes to tools/Nant/doc/help/elements/NAnt.SourceControl.Tasks.AbstractSourceControlTask.html

  • Committer: Manuel de la Pena
  • Date: 2010-07-08 13:22:59 UTC
  • Revision ID: mandel@themacaque.com-20100708132259-y1jgyuyqfe9stt8u
Updated build script to run tests and added all the required tools so far.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
  <!-- Documenting T:NAnt.SourceControl.Tasks.AbstractSourceControlTask-->
 
4
  <head>
 
5
    <meta http-equiv="Content-Language" content="en-ca" />
 
6
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
7
    <link rel="stylesheet" type="text/css" href="../style.css" />
 
8
    <title>AbstractSourceControlTask Element</title>
 
9
  </head>
 
10
  <body>
 
11
    <table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
 
12
      <tr>
 
13
        <td class="NavBar-Cell">
 
14
          <a href="http://nant.sourceforge.net">
 
15
            <b>NAnt</b>
 
16
          </a>
 
17
          <img alt="-&gt;" src="../images/arrow.gif" />
 
18
          <a href="../index.html">Help</a>
 
19
          <img alt="-&gt;" src="../images/arrow.gif" />
 
20
          <span>Element Reference</span>
 
21
          <img alt="-&gt;" src="../images/arrow.gif" /> AbstractSourceControlTask</td>
 
22
        <td class="NavBar-Cell" align="right">
 
23
                        v0.90</td>
 
24
      </tr>
 
25
    </table>
 
26
    <h1>AbstractSourceControlTask</h1>
 
27
    <p> A base class for creating tasks for executing CVS client commands on a CVS repository. </p>
 
28
    <h3>Parameters</h3>
 
29
    <div class="table">
 
30
      <table>
 
31
        <tr>
 
32
          <th>Attribute</th>
 
33
          <th style="text-align: center;">Type</th>
 
34
          <th>Description</th>
 
35
          <th style="text-align: center;">Required</th>
 
36
        </tr>
 
37
        <tr>
 
38
          <td valign="top">commandline</td>
 
39
          <td style="text-align: center;">string</td>
 
40
          <td> Command-line arguments for the program. The command line arguments are used to specify any cvs command options that are not available as attributes. These are appended after the command itself and are additive to whatever attributes are currently specified. </td>
 
41
          <td style="text-align: center;">False</td>
 
42
        </tr>
 
43
        <tr>
 
44
          <td valign="top">destination</td>
 
45
          <td style="text-align: center;">directory</td>
 
46
          <td> Destination directory for the local sandbox. If destination is not specified then the current directory is used. </td>
 
47
          <td style="text-align: center;">False</td>
 
48
        </tr>
 
49
        <tr>
 
50
          <td valign="top">passfile</td>
 
51
          <td style="text-align: center;">file</td>
 
52
          <td> The full path to the cached password file. If not specified then the environment variables are used to try and locate the file. </td>
 
53
          <td style="text-align: center;">False</td>
 
54
        </tr>
 
55
        <tr>
 
56
          <td valign="top">password</td>
 
57
          <td style="text-align: center;">string</td>
 
58
          <td>
 
59
            <i>Deprecated.</i>  The password for logging in to the repository. </td>
 
60
          <td style="text-align: center;">False</td>
 
61
        </tr>
 
62
        <tr>
 
63
          <td valign="top">ssh</td>
 
64
          <td style="text-align: center;">file</td>
 
65
          <td> The executable to use for ssh communication. </td>
 
66
          <td style="text-align: center;">False</td>
 
67
        </tr>
 
68
        <tr>
 
69
          <td valign="top">failonerror</td>
 
70
          <td style="text-align: center;">bool</td>
 
71
          <td> Determines if task failure stops the build, or is just reported. The default is <b>true</b>. </td>
 
72
          <td style="text-align: center;">False</td>
 
73
        </tr>
 
74
        <tr>
 
75
          <td valign="top">if</td>
 
76
          <td style="text-align: center;">bool</td>
 
77
          <td> If <b>true</b> then the task will be executed; otherwise, skipped. The default is <b>true</b>. </td>
 
78
          <td style="text-align: center;">False</td>
 
79
        </tr>
 
80
        <tr>
 
81
          <td valign="top">timeout</td>
 
82
          <td style="text-align: center;">int</td>
 
83
          <td> The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. </td>
 
84
          <td style="text-align: center;">False</td>
 
85
        </tr>
 
86
        <tr>
 
87
          <td valign="top">unless</td>
 
88
          <td style="text-align: center;">bool</td>
 
89
          <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>
 
90
          <td style="text-align: center;">False</td>
 
91
        </tr>
 
92
        <tr>
 
93
          <td valign="top">verbose</td>
 
94
          <td style="text-align: center;">bool</td>
 
95
          <td> Determines whether the task should report detailed build log messages. The default is <b>false</b>. </td>
 
96
          <td style="text-align: center;">False</td>
 
97
        </tr>
 
98
      </table>
 
99
    </div>
 
100
    <h3>Framework-configurable parameters</h3>
 
101
    <div class="table">
 
102
      <table>
 
103
        <tr>
 
104
          <th>Attribute</th>
 
105
          <th style="text-align: center;">Type</th>
 
106
          <th>Description</th>
 
107
          <th style="text-align: center;">Required</th>
 
108
        </tr>
 
109
        <tr>
 
110
          <td valign="top">managed</td>
 
111
          <td style="text-align: center;">
 
112
            <a href="../enums/NAnt.Core.Types.ManagedExecution.html">ManagedExecution</a>
 
113
          </td>
 
114
          <td> Specifies whether the external program should be treated as a managed application, possibly forcing it to be executed under the currently targeted version of the CLR. </td>
 
115
          <td style="text-align: center;">False</td>
 
116
        </tr>
 
117
        <tr>
 
118
          <td valign="top">useruntimeengine</td>
 
119
          <td style="text-align: center;">bool</td>
 
120
          <td>
 
121
            <i>Deprecated.</i>  Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is <b>false</b>. </td>
 
122
          <td style="text-align: center;">False</td>
 
123
        </tr>
 
124
      </table>
 
125
    </div>
 
126
    <h3>Nested Elements:</h3>
 
127
    <!--Element-->
 
128
    <h4>
 
129
      <a id="fileset">
 
130
      </a>
 
131
                    &lt;<a href="../types/fileset.html">fileset</a>&gt;
 
132
                </h4>
 
133
    <div class="nested-element"> Used to specify the version control system (VCS) files that are going to be acted on. <p /></div>
 
134
    <h4>
 
135
      <a id="fileset">
 
136
      </a>
 
137
                    &lt;/<a href="../types/fileset.html">fileset</a>&gt;
 
138
                </h4>
 
139
    <!--Array-->
 
140
    <!--NestedElementArray=T:NAnt.Core.Types.Argument-->
 
141
    <h4>
 
142
      <a id="arg">
 
143
      </a>
 
144
                    &lt;arg&gt;
 
145
                </h4>
 
146
    <div class="nested-element"> The command-line arguments for the external program. <p> Represents a command-line argument. </p><p> When passed to an external application, the argument will be quoted when appropriate. This does not apply to the <code>line</code> parameter, which is always passed as is. </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">dir</td><td style="text-align: center;">directory</td><td> The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">file</td><td style="text-align: center;">file</td><td> The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> Indicates if the argument should be passed to the external program. If <b>true</b> then the argument will be passed; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">line</td><td style="text-align: center;">string</td><td> List of command-line arguments; will be passed to the executable as is. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">path</td><td style="text-align: center;">&lt;path&gt;</td><td> The value for a PATH-like command-line argument; you can use <code>:</code> or <code>;</code> as path separators and NAnt will convert it to the platform's local conventions, while resolving references to environment variables. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Indicates if the argument should not be passed to the external program. If <b>false</b> then the argument will be passed; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">value</td><td style="text-align: center;">string</td><td> A single command-line argument; can contain space characters. </td><td style="text-align: center;">False</td></tr></table></div><h3>Nested Elements:</h3><!--Element--><h4><a id="path"></a>
 
147
                    &lt;<a href="../types/path.html">path</a>&gt;
 
148
                </h4><div class="nested-element"> Sets a single command-line argument and treats it like a PATH - ensures the right separator for the local platform is used. <p /></div><h4><a id="path"></a>
 
149
                    &lt;/<a href="../types/path.html">path</a>&gt;
 
150
                </h4><h3>Examples</h3><ul class="examples"><li><p> A single command-line argument containing a space character. </p><pre class="code">
 
151
&lt;arg value="-l -a" /&gt;
 
152
    </pre></li><li><p> Two separate command-line arguments. </p><pre class="code">
 
153
&lt;arg line="-l -a" /&gt;
 
154
    </pre></li><li><p> A single command-line argument with the value <code>\dir;\dir2;\dir3</code> on DOS-based systems and <code>/dir:/dir2:/dir3</code> on Unix-like systems. </p><pre class="code">
 
155
&lt;arg path="/dir;/dir2:\dir3" /&gt;
 
156
    </pre></li></ul></div>
 
157
    <h4>
 
158
      <a id="arg">
 
159
      </a>
 
160
                    &lt;/arg&gt;
 
161
                </h4>
 
162
    <h3>Requirements</h3>
 
163
    <div style="margin-left: 20px;">
 
164
      <b>Assembly:</b> NAnt.SourceControlTasks (0.90.3780.0)
 
165
            </div>
 
166
  </body>
 
167
</html>
 
 
b'\\ No newline at end of file'