NAntContrib Help Task Reference <svn-checkout> | v0.93-nightly-2015-02-12 |
[This is preliminary documentation and subject to change.]
Executes the svn checkout command.
Attribute | Type | Description | Required |
---|---|---|---|
cache-auth | bool | true if the authentiction token should be cached locally. | False |
config-dir | string | The location of the configuration directory. | False |
recursive | bool | true if the command should be executed recursively. The default is true. | False |
revision | string | The revision to checkout. If no revision is specified then subversion will return the HEAD. |
False |
uri | string |
TODO: Add more documentation when I understand all svn root possibilities/ protocols. The svn root is usually in the form of a URL from which the server, protocol and path information can be derived. Although the path to the repository can also be determined from this the information is more implicit than explicit. For example a subversion root URL of: http://svn.collab.net/repos/svn/trunk/doc/book/tools would have the following components: protocol: http/ web_dav username: anonymous servername: svn.collab.net repository: /repos/svn server path: /trunk/doc/book/tools In addition the revision path or branch can also be determined as subversion stores this information as a seperate physical directory. In this example: revision: trunk |
True |
commandline | string | False | |
destination | directory | False | |
failonerror | bool | Determines if task failure stops the build, or is just reported. The default is true. | False |
if | bool | If true then the task will be executed; otherwise, skipped. The default is true. | False |
passfile | file | False | |
password | string | The pasword to use to login to svn. | False |
quiet | bool | Specifies whether to print as little information as possible. The default is false. | False |
rsh | file | The executable to use for ssh communication. | False |
timeout | int | The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. | False |
unless | bool | Opposite of if . If false then the task will be executed; otherwise, skipped. The default is false. |
False |
username | string | The user performing the checkout. | False |
verbose | bool | Determines whether the task should report detailed build log messages. The default is false. | False |
Attribute | Type | Description | Required |
---|---|---|---|
managed | ManagedExecution | 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. | False |
useruntimeengine | bool | Deprecated. Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is false. | False |
Represents a command-line argument.
When passed to an external application, the argument will be quoted when appropriate. This does not apply to the line
parameter, which is always passed as is.
Attribute | Type | Description | Required |
---|---|---|---|
dir | directory | The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. | False |
file | file | The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. | False |
if | bool | Indicates if the argument should be passed to the external program. If true then the argument will be passed; otherwise, skipped. The default is true. | False |
line | string | List of command-line arguments; will be passed to the executable as is. | False |
path | <path> | The value for a PATH-like command-line argument; you can use : or ; as path separators and NAnt will convert it to the platform's local conventions, while resolving references to environment variables. | False |
unless | bool | Indicates if the argument should not be passed to the external program. If false then the argument will be passed; otherwise, skipped. The default is false. | False |
value | string | A single command-line argument; can contain space characters. | False |
A single command-line argument containing a space character.
<arg value="-l -a" />
Two separate command-line arguments.
<arg line="-l -a" />
A single command-line argument with the value \dir;\dir2;\dir3
on DOS-based systems and /dir:/dir2:/dir3
on Unix-like systems.
<arg path="/dir;/dir2:\dir3" />
Checkout Gentle.NET.
<svn-update destination="c:/dev/src/gentle.net" uri="http://www.mertner.com/svn/repos/projects/gentle" recursive="true" verbose="false" username="anonymoose" password="Canada" revision="HEAD" cache-auth="false" config-dir="c:\home" />