main
1<?xml version="1.0"?>
2<doc>
3 <assembly>
4 <name>NAnt.SourceControlTasks</name>
5 </assembly>
6 <members>
7 <member name="T:NAnt.SourceControl.Tasks.AbstractCvsTask">
8 <summary>
9 A base class for creating tasks for executing CVS client commands on a
10 CVS repository.
11 </summary>
12 </member>
13 <member name="T:NAnt.SourceControl.Tasks.AbstractSourceControlTask">
14 <summary>
15 A base class for creating tasks for executing CVS client commands on a
16 CVS repository.
17 </summary>
18 </member>
19 <member name="F:NAnt.SourceControl.Tasks.AbstractSourceControlTask.EnvHome">
20 <summary>
21 Name of the environmental variable specifying a users' home
22 in a *nix environment.
23 </summary>
24 </member>
25 <member name="F:NAnt.SourceControl.Tasks.AbstractSourceControlTask.AppData">
26 <summary>
27 Used on windows to specify the location of application data.
28 </summary>
29 </member>
30 <member name="F:NAnt.SourceControl.Tasks.AbstractSourceControlTask.PathVariable">
31 <summary>
32 The environment variable that holds path information.
33 </summary>
34 </member>
35 <member name="F:NAnt.SourceControl.Tasks.AbstractSourceControlTask.CvsPassFileVariable">
36 <summary>
37 The environment variable that holds the location of the
38 .cvspass file.
39 </summary>
40 </member>
41 <member name="F:NAnt.SourceControl.Tasks.AbstractSourceControlTask.PropExeName">
42 <summary>
43 Property name used to specify the source control executable. This is
44 used as a readonly property.
45 </summary>
46 </member>
47 <member name="M:NAnt.SourceControl.Tasks.AbstractSourceControlTask.#ctor">
48 <summary>
49 Initializes a new instance of the <see cref="T:NAnt.SourceControl.Tasks.AbstractCvsTask"/>
50 class.
51 </summary>
52 </member>
53 <member name="M:NAnt.SourceControl.Tasks.AbstractSourceControlTask.PrepareProcess(System.Diagnostics.Process)">
54 <summary>
55 Build up the command line arguments, determine which executable is being
56 used and find the path to that executable and set the working
57 directory.
58 </summary>
59 <param name="process">The process to prepare.</param>
60 </member>
61 <member name="M:NAnt.SourceControl.Tasks.AbstractSourceControlTask.SetGlobalOption(System.String,System.String,System.Boolean)">
62 <summary>
63 Adds a new global option if none exists. If one does exist then
64 the use switch is toggled on or of.
65 </summary>
66 <param name="name">The common name of the option.</param>
67 <param name="value">The option value or command line switch
68 of the option.</param>
69 <param name="on"><code>true</code> if the option should be
70 appended to the commandline, otherwise <code>false</code>.</param>
71 </member>
72 <member name="M:NAnt.SourceControl.Tasks.AbstractSourceControlTask.SetCommandOption(System.String,System.String,System.Boolean)">
73 <summary>
74 Adds a new command option if none exists. If one does exist then
75 the use switch is toggled on or of.
76 </summary>
77 <param name="name">The common name of the option.</param>
78 <param name="value">The option value or command line switch
79 of the option.</param>
80 <param name="on"><code>true</code> if the option should be
81 appended to the commandline, otherwise <code>false</code>.</param>
82 </member>
83 <member name="M:NAnt.SourceControl.Tasks.AbstractSourceControlTask.SetEnvironment(System.Diagnostics.Process)">
84 <summary>
85 Set up the environment variables for a process.
86 </summary>
87 <param name="process">A process to setup.</param>
88 </member>
89 <member name="M:NAnt.SourceControl.Tasks.AbstractSourceControlTask.AppendFiles">
90 <summary>
91 Append the files specified in the fileset to the command line argument.
92 Files are changed to use a relative path from the working directory
93 that the task is spawned in.
94 </summary>
95 </member>
96 <member name="M:NAnt.SourceControl.Tasks.AbstractSourceControlTask.DeriveVcsFromEnvironment">
97 <summary>
98 Derive the location of the version control system from the environment
99 variable <code>PATH</code>.
100 </summary>
101 <returns>The file information of the version control system,
102 or <code>null</code> if this cannot be found.</returns>
103 </member>
104 <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.PassFileName">
105 <summary>
106 The name of the passfile, overriden for each version control system (VCS).
107 </summary>
108 </member>
109 <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.VcsHome">
110 <summary>
111 The path to the specific home directory of the version control system,
112 this can be where the binary files are kept, or other app
113 information.
114 </summary>
115 </member>
116 <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.VcsHomeEnv">
117 <summary>
118 The environment variable that defines where the version control system
119 (VCS) home variable is kept.
120 </summary>
121 </member>
122 <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.VcsExeName">
123 <summary>
124 The name of the version control system (VCS) executable file.
125 </summary>
126 </member>
127 <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.Root">
128 <summary>
129 <para>
130 The root variable contains information on how to locate a repository.
131 Although this information is in different formats it typically must
132 define the following:
133 <list type="table">
134 <item>server location</item>
135 <item>protocol used to communicate with the repository</item>
136 <item>repository location on the server</item>
137 <item>project location in the repository</item>
138 </list>
139 </para>
140 </summary>
141 </member>
142 <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.DestinationDirectory">
143 <summary>
144 Destination directory for the local sandbox. If destination is not specified
145 then the current directory is used.
146 </summary>
147 <value>
148 Root path of the local sandbox.
149 </value>
150 <remarks>
151 <para>
152 Root path of the local sandbox.
153 </para>
154 </remarks>
155 </member>
156 <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.Password">
157 <summary>
158 The password for logging in to the repository.
159 </summary>
160 <value>
161 The password for logging in to the repository.
162 </value>
163 </member>
164 <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.PassFile">
165 <summary>
166 The full path to the cached password file. If not specified then the
167 environment variables are used to try and locate the file.
168 </summary>
169 </member>
170 <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.GlobalOptions">
171 <summary>
172 Holds a collection of globally available options.
173 </summary>
174 </member>
175 <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.CommandOptions">
176 <summary>
177 A collection of options that can be used to modify the default behavoir
178 of the version control commands. See the sub-tasks for implementation
179 specifics.
180 </summary>
181 </member>
182 <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.CommandLineArguments">
183 <summary>
184 Command-line arguments for the program. The command line arguments are used to specify
185 any cvs command options that are not available as attributes. These are appended
186 after the command itself and are additive to whatever attributes are currently specified.
187 </summary>
188 <example>
189 <cvs-checkout cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
190 module="nant"
191 destination="e:\test\merillcornish\working"
192 readonly="true"
193 quiet="true"
194 commandline="-n"
195 cvsfullpath="C:\Program Files\TortoiseCVS\cvs.exe"
196 />
197 <br />
198 Produces the cvs command:
199 <code>c:\Program Files\TortoiseCVS\cvs.exe -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant -q checkout -n nant</code>
200 </example>
201 </member>
202 <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.CommandName">
203 <summary>
204 The name of the command that is going to be executed.
205 </summary>
206 </member>
207 <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.VcsFileSet">
208 <summary>
209 Used to specify the version control system (VCS) files that are going
210 to be acted on.
211 </summary>
212 </member>
213 <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.Ssh">
214 <summary>
215 The executable to use for ssh communication.
216 </summary>
217 </member>
218 <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.SshEnv">
219 <summary>
220 The environment name for the ssh variable.
221 </summary>
222 </member>
223 <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.ExeName">
224 <summary>
225 The name of the version control system executable.
226 </summary>
227 </member>
228 <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.ProgramArguments">
229 <summary>
230 Get the command line arguments for the task.
231 </summary>
232 </member>
233 <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.DefaultRecursive">
234 <summary>
235 Default value for the recursive directive. The default is
236 <see langword="false" />.
237 </summary>
238 </member>
239 <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.DefaultQuiet">
240 <summary>
241 Default value for the quiet command.
242 </summary>
243 </member>
244 <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.DefaultReallyQuiet">
245 <summary>
246 Default value for the really quiet command.
247 </summary>
248 </member>
249 <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.CvsHome">
250 <summary>
251 An environment variable that holds path information about where
252 cvs is located.
253 </summary>
254 </member>
255 <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.CvsPassfile">
256 <summary>
257 Name of the password file that cvs stores pserver
258 cvsroot/ password pairings.
259 </summary>
260 </member>
261 <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.DefaultCompressionLevel">
262 <summary>
263 The default compression level to use for cvs commands.
264 </summary>
265 </member>
266 <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.DefaultUseSharpCvsLib">
267 <summary>
268 The default use of binaries, defaults to use sharpcvs.
269 </summary>
270 </member>
271 <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.CvsExe">
272 <summary>
273 The name of the cvs executable.
274 </summary>
275 </member>
276 <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.SharpCvsExe">
277 <summary>
278 The temporary name of the sharpcvslib binary file, to avoid
279 conflicts in the path variable.
280 </summary>
281 </member>
282 <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.CvsRsh">
283 <summary>
284 Environment variable that holds the executable name that is used for
285 ssh communication.
286 </summary>
287 </member>
288 <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.UseSharpCvsLibProp">
289 <summary>
290 Property name used to specify on a project level whether sharpcvs is
291 used or not.
292 </summary>
293 </member>
294 <member name="M:NAnt.SourceControl.Tasks.AbstractCvsTask.#ctor">
295 <summary>
296 Initializes a new instance of the <see cref="T:NAnt.SourceControl.Tasks.AbstractCvsTask"/>
297 class.
298 </summary>
299 </member>
300 <member name="M:NAnt.SourceControl.Tasks.AbstractCvsTask.PrepareProcess(System.Diagnostics.Process)">
301 <summary>
302 Build up the command line arguments, determine which executable is being
303 used and find the path to that executable and set the working
304 directory.
305 </summary>
306 <param name="process">The process to prepare.</param>
307 </member>
308 <member name="M:NAnt.SourceControl.Tasks.AbstractCvsTask.AppendSubCommandArgs">
309 <summary>
310 Override to append any commands before the modele and files.
311 </summary>
312 </member>
313 <member name="M:NAnt.SourceControl.Tasks.AbstractCvsTask.AppendCommandOptions">
314 <summary>
315 Append the command line options or commen names for the options
316 to the generic options collection. This is then piped to the
317 command line as a switch.
318 </summary>
319 </member>
320 <member name="M:NAnt.SourceControl.Tasks.AbstractCvsTask.AddArg(System.String)">
321 <summary>
322 Add the given argument to the command line options. Note that are not explicitly
323 quoted are split into seperate arguments. This is to resolve a recent issue
324 with quoting command line arguments.
325 </summary>
326 <param name="arg"></param>
327 </member>
328 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.SshEnv">
329 <summary>
330 The environment name for the ssh variable.
331 </summary>
332 </member>
333 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.VcsExeName">
334 <summary>
335 The name of the cvs binary, or <c>cvs.exe</c> at the time this
336 was written.
337 </summary>
338 </member>
339 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.PassFileName">
340 <summary>
341 The name of the pass file, or <c>.cvspass</c> at the time
342 of this writing.
343 </summary>
344 </member>
345 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.VcsHomeEnv">
346 <summary>
347 The name of the version control system specific home environment
348 variable.
349 </summary>
350 </member>
351 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.IsModuleNeeded">
352 <summary>
353 Specify if the module is needed for this cvs command. It is
354 only needed if there is no module information on the local file
355 system.
356 </summary>
357 </member>
358 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.CvsFileSet">
359 <summary>
360 Used to specify the version control system (VCS) files that are going
361 to be acted on.
362 </summary>
363 </member>
364 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.VcsFileSet">
365 <summary>
366 Get the cvs file set.
367 </summary>
368 </member>
369 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.ExeName">
370 <summary>
371 The name of the cvs executable.
372 </summary>
373 </member>
374 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.CvsFullPath">
375 <summary>
376 The full path to the cvs binary used. The cvs tasks will attempt to
377 "guess" the location of your cvs binary based on your path. If the
378 task is unable to resolve the location, or resolves it incorrectly
379 this can be used to manually specify the path.
380 </summary>
381 <value>
382 A full path (i.e. including file name) of your cvs binary:
383 On Windows: c:\vcs\cvs\cvs.exe
384 On *nix: /usr/bin/cvs
385 </value>
386 </member>
387 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.Root">
388 <summary>
389 <para>
390 The cvs root variable has the following components:
391 </para>
392 <para>
393 <code>[protocol]:[username]@[servername]:[server path]</code>
394 <ul>
395 <li>protocol: ext, pserver, ssh (sharpcvslib); if you are not using sharpcvslib consult your cvs documentation.</li>
396 <li>username: [username]</li>
397 <li>servername: cvs.sourceforge.net</li>
398 <li>server path: /cvsroot/nant</li>
399 </ul>
400 </para>
401 </summary>
402 <example>
403 <para>NAnt anonymous cvsroot:</para>
404 <code>
405 :pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant
406 </code>
407 </example>
408 </member>
409 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.Module">
410 <summary>
411 The module to perform an operation on.
412 </summary>
413 <value>
414 The module to perform an operation on. This is a normal file/folder
415 name without path information.
416 </value>
417 <example>
418 <para>In NAnt the module name would be:</para>
419 <code>nant</code>
420 </example>
421 </member>
422 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.UseSharpCvsLib">
423 <summary>
424 <para>
425 <see langword="true" /> if the SharpCvsLib binaries that come bundled
426 with NAnt should be used to perform the cvs commands, <see langword="false" />
427 otherwise.
428 </para>
429 <para>
430 You may also specify an override value for all cvs tasks instead
431 of specifying a value for each. To do this set the property
432 <c>sourcecontrol.usesharpcvslib</c> to <see langword="false" />.
433 </para>
434 <warn>
435 If you choose not to use SharpCvsLib to checkout from cvs you will
436 need to include a cvs.exe binary in your path.
437 </warn>
438 </summary>
439 <example>
440 To use a cvs client in your path instead of sharpcvslib specify
441 the property:
442 >property name="sourcecontrol.usesharpcvslib" value="false"<
443
444 The default settings is to use sharpcvslib and the setting closest
445 to the task execution is used to determine which value is used
446 to execute the process.
447
448 For instance if the attribute usesharpcvslib was set to false
449 and the global property was set to true, the usesharpcvslib is
450 closes to the point of execution and would be used and is false.
451 Therefore the sharpcvslib binary would NOT be used.
452 </example>
453 </member>
454 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.Ssh">
455 <summary>
456 The executable to use for ssh communication.
457 </summary>
458 </member>
459 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.Quiet">
460 <summary>
461 Indicates if the output from the cvs command should be supressed.
462 The default is <see langword="false" />.
463 </summary>
464 </member>
465 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.ReallyQuiet">
466 <summary>
467 Indicates if the output from the cvs command should be stopped.
468 The default is <see langword="false" />.
469 </summary>
470 </member>
471 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.ReadOnly">
472 <summary>
473 <see langword="true" /> if the sandbox files should be checked out in
474 read only mode. The default is <see langword="false" />.
475 </summary>
476 </member>
477 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.ReadWrite">
478 <summary>
479 <see langword="true" /> if the sandbox files should be checked out in
480 read/write mode. The default is <see langword="true" />.
481 </summary>
482 </member>
483 <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.CompressionLevel">
484 <summary>
485 Compression level to use for all net traffic. This should be a value from 1-9.
486 <br />
487 <br />
488 <bold>NOTE: This is not available on sharpcvslib.</bold>
489 </summary>
490 </member>
491 <member name="T:NAnt.SourceControl.Tasks.ChangeLogTask">
492 <summary>
493 Produces an XML report that represents the cvs changes from the given
494 start day, to a given end date.
495 </summary>
496 <example>
497 <para>Report changes in NAnt from 1st of June 2004 until 25th of July 2004.</para>
498 <code>
499 <![CDATA[
500 <cvs-changelog
501 destination="e:/test/nant/sourcecontrol/"
502 cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
503 module="nant"
504 start="2004/06/01"
505 end="2004/07/25"
506 xmlfile="e:/test/nant/sourcecontrol/changelog-nant.xml"
507 />
508 ]]>
509 </code>
510 </example>
511 </member>
512 <member name="F:NAnt.SourceControl.Tasks.ChangeLogTask.CvsCommandName">
513 <summary>
514 The command being executed.
515 </summary>
516 </member>
517 <member name="P:NAnt.SourceControl.Tasks.ChangeLogTask.DestFile">
518 <summary>
519 Name of the xml file that will contain the cvs log information.
520 </summary>
521 </member>
522 <member name="P:NAnt.SourceControl.Tasks.ChangeLogTask.StartDate">
523 <summary>
524 The earliest change to use in the cvs log command.
525 </summary>
526 </member>
527 <member name="P:NAnt.SourceControl.Tasks.ChangeLogTask.EndDate">
528 <summary>
529 The latest date to use in the cvs log command.
530 </summary>
531 </member>
532 <member name="P:NAnt.SourceControl.Tasks.ChangeLogTask.CommandName">
533 <summary>
534 The cvs command to execute.
535 </summary>
536 </member>
537 <member name="P:NAnt.SourceControl.Tasks.ChangeLogTask.UseSharpCvsLib">
538 <summary>
539 Override use of sharpcvslib, needs to be true.
540 </summary>
541 </member>
542 <member name="P:NAnt.SourceControl.Tasks.ChangeLogTask.Root">
543 <summary>
544 <para>
545 The cvs root variable has the following components:
546 </para>
547 <para>
548 <code>[protocol]:[username]@[servername]:[server path]</code>
549 <ul>
550 <li>protocol: ext, pserver, ssh (sharpcvslib); if you are not using sharpcvslib consult your cvs documentation.</li>
551 <li>username: [username]</li>
552 <li>servername: cvs.sourceforge.net</li>
553 <li>server path: /cvsroot/nant</li>
554 </ul>
555 </para>
556 <para>
557 If the cvsroot is not specified then the directory specified by the
558 <see cref="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.DestinationDirectory"/> attribute
559 is searched for CVS\Root.
560 </para>
561 </summary>
562 <example>
563 <para>NAnt anonymous cvsroot:</para>
564 <code>
565 :pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant
566 </code>
567 </example>
568 </member>
569 <member name="T:NAnt.SourceControl.Tasks.CheckoutTask">
570 <summary>
571 Checks out a CVS module to the required directory.
572 </summary>
573 <example>
574 <para>Checkout NAnt.</para>
575 <code>
576 <![CDATA[
577 <cvs-checkout
578 destination="c:\src\nant\"
579 cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
580 module="nant" />
581 ]]>
582 </code>
583 </example>
584 <example>
585 <para>
586 Checkout NAnt revision named <c>0_85</c> to the
587 folder <c>c:\src\nant\v0.85</c>.
588 </para>
589 <code>
590 <![CDATA[
591 <cvs-checkout
592 destination="c:\src\nant"
593 cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
594 module="nant"
595 revision="0_85"
596 overridedir="v0.85" />
597 ]]>
598 </code>
599 <para>So the nant module tagged with revision 0_85 will be checked
600 out in the folder v0.85 under the working/ destination directory.
601 <br/>This could be used to work on different
602 branches of a repository at the same time.</para>
603 </example>
604 <example>
605 <para>
606 Checkout NAnt with specified revision date to the
607 folder <c>c:\src\nant\2003_08_16</c>.
608 </para>
609 <code>
610 <![CDATA[
611 <cvs-checkout
612 destination="c:\src\nant\"
613 cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
614 module="nant"
615 date="2003/08/16"
616 overridedir="2003_08_16" />
617 ]]>
618 </code>
619 </example>
620 </member>
621 <member name="F:NAnt.SourceControl.Tasks.CheckoutTask.CvsCommandName">
622 <summary>
623 The command being executed.
624 </summary>
625 </member>
626 <member name="M:NAnt.SourceControl.Tasks.CheckoutTask.#ctor">
627 <summary>
628 Initializes a new instance of the <see cref="T:NAnt.SourceControl.Tasks.CheckoutTask"/> class.
629 </summary>
630 </member>
631 <member name="P:NAnt.SourceControl.Tasks.CheckoutTask.Revision">
632 <summary>
633 Specify the revision to checkout. This corresponds to the "sticky-tag"
634 of the file.
635 </summary>
636 </member>
637 <member name="P:NAnt.SourceControl.Tasks.CheckoutTask.StickyTag">
638 <summary>
639 Sticky tag or revision to checkout.
640 </summary>
641 </member>
642 <member name="P:NAnt.SourceControl.Tasks.CheckoutTask.Date">
643 <summary>
644 Specify the revision date to checkout. The date specified is validated
645 and then passed to the cvs binary in a standard format recognized by
646 cvs.
647 </summary>
648 </member>
649 <member name="P:NAnt.SourceControl.Tasks.CheckoutTask.OverrideDir">
650 <summary>
651 Specify a directory name to replace the module name. Valid names
652 include any valid filename, excluding path information.
653 </summary>
654 </member>
655 <member name="P:NAnt.SourceControl.Tasks.CheckoutTask.OverrideDirectory">
656 <summary>
657 Specify a directory name to replace the module name. Valid names
658 include any valid filename, excluding path information.
659 </summary>
660 </member>
661 <member name="P:NAnt.SourceControl.Tasks.CheckoutTask.CommandName">
662 <summary>
663 The name of the cvs command that is going to be executed.
664 </summary>
665 </member>
666 <member name="T:NAnt.SourceControl.Tasks.CvsPass">
667 <summary>
668 Executes the cvs login command which appends or updates an entry to the
669 specified .cvspass file.
670 </summary>
671 <example>
672 <para>Update .cvspass file to include the NAnt anonymous login.</para>
673 <code>
674 <![CDATA[
675 <cvs-pass cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
676 password="anonymous"
677 passfile="C:\.cvspass" />
678 ]]>
679 </code>
680 </example>
681 </member>
682 <member name="M:NAnt.SourceControl.Tasks.CvsPass.Initialize">
683 <summary>
684 Ensures all information is available to execute the <see cref="T:NAnt.Core.Task"/>.
685 </summary>
686 </member>
687 <member name="M:NAnt.SourceControl.Tasks.CvsPass.ExecuteTask">
688 <summary>
689 Update the .cvspass file with the given password. If the passfile
690 is not specified then the default search locations are used:
691 <list type="list">
692 <item>CVS_PASSFILE/.cvspass</item>
693 <item>HOME/.cvspass</item>
694 <item>USERPROFILE/.cvspass TODO: Confirm that this is valid
695 behavior or if it is going to give problems with the
696 cvsnt implementation.</item>
697 </list>
698 </summary>
699 </member>
700 <member name="P:NAnt.SourceControl.Tasks.CvsPass.Password">
701 <summary>
702 Password to append or update to the .cvspass file.
703 </summary>
704 </member>
705 <member name="P:NAnt.SourceControl.Tasks.CvsPass.PassFile">
706 <summary>
707 The full path to the .cvspass file. The default is ~/.cvspass.
708 </summary>
709 <value></value>
710 </member>
711 <member name="P:NAnt.SourceControl.Tasks.CvsPass.DestinationDirectory">
712 <summary>
713 The current working directory.
714 </summary>
715 </member>
716 <member name="P:NAnt.SourceControl.Tasks.CvsPass.Root">
717 <summary>
718 The repository root string.
719 </summary>
720 </member>
721 <member name="T:NAnt.SourceControl.Tasks.CvsTask">
722 <summary>
723 Executes the cvs command specified by the command attribute.
724 </summary>
725 <example>
726 <para>Checkout NAnt.</para>
727 <code>
728 <![CDATA[
729 <cvs command="checkout"
730 destination="c:\src\nant\"
731 cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
732 module="nant" />
733 ]]>
734 </code>
735 </example>
736 </member>
737 <member name="P:NAnt.SourceControl.Tasks.CvsTask.CommandName">
738 <summary>
739 The cvs command to execute.
740 </summary>
741 </member>
742 <member name="P:NAnt.SourceControl.Tasks.CvsTask.IsModuleNeeded">
743 <summary>
744 Specify if the module is needed for this cvs command.
745 </summary>
746 </member>
747 <member name="T:NAnt.SourceControl.Tasks.ExportTask">
748 <summary>
749 Exports a cvs module in preperation for a release (i.e. the CVS version
750 folders are not exported).
751 </summary>
752 <example>
753 <para>Export the most recent NAnt sources from cvs.</para>
754 <code>
755 <![CDATA[
756 <cvs-export
757 destination="c:\src\nant\"
758 cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
759 module="nant" />
760 ]]>
761 </code>
762 </example>
763 <example>
764 <para>
765 Export NAnt revision named <c>your_favorite_revision_here</c> to the
766 folder <c>c:\src\nant\replacement_for_module_directory_name</c>.
767
768 <warn>**NOTE**</warn>: filesets names for the export task must be
769 prefixed with the module name. This is different than other tasks.
770 </para>
771 <code>
772 <![CDATA[
773 <cvs-export
774 destination="c:\src\nant\"
775 cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
776 module="nant"
777 revision="your_favorite_revision_here"
778 overridedir="replacement_for_module_directory_name"
779 recursive="false">
780 <fileset>
781 <include name="nant/bin/NAnt.exe"/>
782 <include name="nant/bin/NAnt.exe.config"/>
783 </fileset>
784 </cvs-export>
785 ]]>
786 </code>
787 </example>
788 </member>
789 <member name="F:NAnt.SourceControl.Tasks.ExportTask.CvsCommandName">
790 <summary>
791 The command being executed.
792 </summary>
793 </member>
794 <member name="M:NAnt.SourceControl.Tasks.ExportTask.#ctor">
795 <summary>
796 Create a new instance of the <see cref="T:NAnt.SourceControl.Tasks.ExportTask"/>.
797 </summary>
798 <value>
799 The following values are set by default:
800 <ul>
801 <li>Recursive: <see langword="true"/></li>
802 </ul>
803 </value>
804 </member>
805 <member name="P:NAnt.SourceControl.Tasks.ExportTask.NoShortening">
806 <summary>
807 No shortening. Do not shorten module paths if -d specified.
808 </summary>
809 </member>
810 <member name="P:NAnt.SourceControl.Tasks.ExportTask.ForceHead">
811 <summary>
812 Indicates whether the head revision should be used if the revison specified by
813 <see cref="P:NAnt.SourceControl.Tasks.ExportTask.Revision"/> or the <see cref="P:NAnt.SourceControl.Tasks.ExportTask.Date"/> tags are not
814 found. The default is <see langword="false"/>.
815 </summary>
816 <value>
817 <see langword="true"/> if the specified tag should be moved;
818 otherwise, <see langword="false"/>. The default is <see langword="false"/>.
819 </value>
820 </member>
821 <member name="P:NAnt.SourceControl.Tasks.ExportTask.Recursive">
822 <summary>
823 If a directory is specified indicates whether sub-directories should
824 also be processed.
825 </summary>
826 <value>
827 <see langword="true" /> if the sub-directories should be tagged;
828 otherwise, <see langword="false" />. The default is <see langword="true" />.
829 </value>
830 </member>
831 <member name="P:NAnt.SourceControl.Tasks.ExportTask.Revision">
832 <summary>
833 Specify the revision to update the file to. This corresponds to the "sticky-tag"
834 of the file.
835 </summary>
836 </member>
837 <member name="P:NAnt.SourceControl.Tasks.ExportTask.Date">
838 <summary>
839 Specify the revision date to update to. The version of the file that
840 existed at the date specified is retrieved.
841 </summary>
842 <value>
843 A valid date time value, which is then converted to a format that
844 cvs can parse.
845 </value>
846 </member>
847 <member name="P:NAnt.SourceControl.Tasks.ExportTask.OverrideDir">
848 <summary>
849 Specify a directory name to replace the module name. Valid names
850 include any valid filename, excluding path information.
851 </summary>
852 </member>
853 <member name="P:NAnt.SourceControl.Tasks.ExportTask.CommandName">
854 <summary>
855 The export command name for the cvs client.
856 </summary>
857 </member>
858 <member name="T:NAnt.SourceControl.Tasks.RTagTask">
859 <summary>
860 Tags all sources in the remote repository with a given tag.
861 </summary>
862 <remarks>
863 <para>
864 Unlike tag, the rtag command acts only on sources that are in the repository.
865 Any modified sources on the local file system will NOT be tagged with this
866 command, so a commit should be performed before an rtag is done.
867 </para>
868 <para>
869 NOTE: Although a working directory is not necessary to perform the command
870 one must be specified in order to remain in compliance with the cvs library.
871 </para>
872 </remarks>
873 <example>
874 <para>Tag NAnt sources remotely.</para>
875 <code>
876 <![CDATA[
877 <cvs-rtag
878 cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
879 destination="."
880 module="nant"
881 tagname="v0_8_4"
882 />
883 ]]>
884 </code>
885 </example>
886 <example>
887 <para>Remove a tag from the remote repository.</para>
888 <code>
889 <![CDATA[
890 <cvs-rtag
891 cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
892 destination="."
893 module="nant"
894 tagname="v0_8_4"
895 remove="true"
896 />
897 ]]>
898 </code>
899 </example>
900 </member>
901 <member name="M:NAnt.SourceControl.Tasks.RTagTask.#ctor">
902 <summary>
903 Initializes a new instance of the <see cref="T:NAnt.SourceControl.Tasks.RTagTask"/>
904 class.
905 </summary>
906 </member>
907 <member name="M:NAnt.SourceControl.Tasks.RTagTask.AppendSubCommandArgs">
908 <summary>
909 Append the tag information to the commandline.
910 </summary>
911 </member>
912 <member name="P:NAnt.SourceControl.Tasks.RTagTask.Tag">
913 <summary>
914 The name of the tag to assign or remove.
915 </summary>
916 <value>
917 The name of the tag to assign or remove.
918 </value>
919 </member>
920 <member name="P:NAnt.SourceControl.Tasks.RTagTask.Remove">
921 <summary>
922 Indicates whether the tag specified in <see cref="P:NAnt.SourceControl.Tasks.RTagTask.Tag"/> should
923 be removed or not.
924 </summary>
925 <value>
926 <see langword="true"/> if the specified tag should be removed;
927 otherwise, <see langword="false"/>. The default is <see langword="false"/>.
928 </value>
929 </member>
930 <member name="P:NAnt.SourceControl.Tasks.RTagTask.MoveIfExists">
931 <summary>
932 Indicates whether the tag specified in <see cref="P:NAnt.SourceControl.Tasks.RTagTask.Tag"/> should
933 be moved to the current file revision. If the tag does not exist
934 then it is created.
935 </summary>
936 <value>
937 <see langword="true"/> if the specified tag should be moved;
938 otherwise, <see langword="false"/>. The default is <see langword="false"/>.
939 </value>
940 </member>
941 <member name="P:NAnt.SourceControl.Tasks.RTagTask.Recursive">
942 <summary>
943 If a directory is specified indicates whether sub-directories should
944 also be processed.
945 </summary>
946 <value>
947 <see langword="true" /> if the sub-directories should be tagged;
948 otherwise, <see langword="false" />. The default is <see langword="true" />.
949 </value>
950 </member>
951 <member name="P:NAnt.SourceControl.Tasks.RTagTask.ActOnTag">
952 <summary>
953 Indicates the repository <see cref="P:NAnt.SourceControl.Tasks.RTagTask.Tag"/> that is acted on
954 for the tag command. Note if <see cref="P:NAnt.SourceControl.Tasks.RTagTask.MoveIfExists"/> is
955 <see langword="true"/> then the tag specified is moved to the revision
956 of the file on the HEAD of the branch specified.
957 </summary>
958 <value>
959 The tag (or more likely) branch that should be used to apply the new tag.
960 </value>
961 </member>
962 <member name="P:NAnt.SourceControl.Tasks.RTagTask.ActOnDate">
963 <summary>
964 Indicates the revision date of the file that the tag should be
965 applied to.
966 </summary>
967 <value>
968 A valid date which specifies the revision point that the tag will
969 be applied to.
970 </value>
971 </member>
972 <member name="P:NAnt.SourceControl.Tasks.RTagTask.ForceHead">
973 <summary>
974 Indicates whether the head revision should be used if the
975 <see cref="P:NAnt.SourceControl.Tasks.RTagTask.ActOnTag"/> or the <see cref="P:NAnt.SourceControl.Tasks.RTagTask.ActOnDate"/> tags are not
976 found.
977 </summary>
978 <value>
979 <see langword="true"/> if the specified tag should be moved;
980 otherwise, <see langword="false"/>. The default is <see langword="false"/>.
981 </value>
982 </member>
983 <member name="P:NAnt.SourceControl.Tasks.RTagTask.CommandName">
984 <summary>
985 The name of the cvs command that is going to be executed.
986 </summary>
987 </member>
988 <member name="T:NAnt.SourceControl.Tasks.TagTask">
989 <summary>
990 Tags all local sources with the specified tag.
991 </summary>
992 <remarks>
993 <para>
994 This differs from the
995 <see cref="T:NAnt.SourceControl.Tasks.RTagTask"/> in that it acts on references to the cvs files
996 contained in your local filesystem. As such the sticky tags and local
997 revisions can be considered in commits. It also allows you to verify that
998 all local files have been checked in before a tag is performed.
999 </para>
1000 </remarks>
1001 <example>
1002 <para>Tag NAnt sources remotely.</para>
1003 <code>
1004 <![CDATA[
1005 <cvs-tag
1006 cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
1007 destination="."
1008 module="nant"
1009 tagname="v0_8_4"
1010 />
1011 ]]>
1012 </code>
1013 </example>
1014 <example>
1015 <para>Remove a tag from the remote repository.</para>
1016 <code>
1017 <![CDATA[
1018 <cvs-tag
1019 cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
1020 destination="."
1021 module="nant"
1022 tagname="v0_8_4"
1023 remove="true"
1024 fail-if-modified="true"
1025 />
1026 ]]>
1027 </code>
1028 </example>
1029 </member>
1030 <member name="F:NAnt.SourceControl.Tasks.TagTask.CvsCommandName">
1031 <summary>
1032 Cvs command to be executed.
1033 </summary>
1034 </member>
1035 <member name="M:NAnt.SourceControl.Tasks.TagTask.#ctor">
1036 <summary>
1037 Initializes a new instance of the <see cref="T:NAnt.SourceControl.Tasks.TagTask"/>
1038 class.
1039 </summary>
1040 </member>
1041 <member name="M:NAnt.SourceControl.Tasks.TagTask.AppendSubCommandArgs">
1042 <summary>
1043 Append the tag information to the commandline.
1044 </summary>
1045 </member>
1046 <member name="P:NAnt.SourceControl.Tasks.TagTask.Tag">
1047 <summary>
1048 The name of the tag to assign or remove.
1049 </summary>
1050 <value>
1051 The name of the tag to assign or remove.
1052 </value>
1053 </member>
1054 <member name="P:NAnt.SourceControl.Tasks.TagTask.Remove">
1055 <summary>
1056 Indicates whether the tag specified in <see cref="P:NAnt.SourceControl.Tasks.TagTask.Tag"/> should
1057 be removed or not.
1058 </summary>
1059 <value>
1060 <see langword="true"/> if the specified tag should be removed;
1061 otherwise, <see langword="false"/>. The default is <see langword="false"/>.
1062 </value>
1063 </member>
1064 <member name="P:NAnt.SourceControl.Tasks.TagTask.MoveIfExists">
1065 <summary>
1066 Indicates whether the tag specified in <see cref="P:NAnt.SourceControl.Tasks.TagTask.Tag"/> should
1067 be moved to the current file revision. If the tag does not exist
1068 then it is created.
1069 </summary>
1070 <value>
1071 <see langword="true"/> if the specified tag should be moved;
1072 otherwise, <see langword="false"/>. The default is <see langword="false"/>.
1073 </value>
1074 </member>
1075 <member name="P:NAnt.SourceControl.Tasks.TagTask.Recursive">
1076 <summary>
1077 If a directory is specified indicates whether sub-directories should
1078 also be processed.
1079 </summary>
1080 <value>
1081 <see langword="true" /> if the sub-directories should be tagged;
1082 otherwise, <see langword="false" />. The default is <see langword="true" />.
1083 </value>
1084 </member>
1085 <member name="P:NAnt.SourceControl.Tasks.TagTask.ActOnTag">
1086 <summary>
1087 Indicates the repository <see cref="P:NAnt.SourceControl.Tasks.TagTask.Tag"/> that is acted on
1088 for the tag command. Note if <see cref="P:NAnt.SourceControl.Tasks.TagTask.MoveIfExists"/> is
1089 <see langword="true"/> then the tag specified is moved to the revision
1090 of the file on the HEAD of the branch specified.
1091 </summary>
1092 <value>
1093 The tag (or more likely) branch that should be used to apply the new tag.
1094 </value>
1095 </member>
1096 <member name="P:NAnt.SourceControl.Tasks.TagTask.ActOnDate">
1097 <summary>
1098 Indicates the revision date of the file that the tag should be
1099 applied to.
1100 </summary>
1101 <value>
1102 A valid date which specifies the revision point that the tag will
1103 be applied to.
1104 </value>
1105 </member>
1106 <member name="P:NAnt.SourceControl.Tasks.TagTask.ForceHead">
1107 <summary>
1108 Indicates whether the head revision should be used if the revision specified by
1109 <see cref="P:NAnt.SourceControl.Tasks.TagTask.ActOnTag"/> or the <see cref="P:NAnt.SourceControl.Tasks.TagTask.ActOnDate"/> tags are not
1110 found.
1111 </summary>
1112 <value>
1113 <see langword="true"/> if the specified tag should be moved;
1114 otherwise, <see langword="false"/>. The default is <see langword="false"/>.
1115 </value>
1116 </member>
1117 <member name="P:NAnt.SourceControl.Tasks.TagTask.FailIfModified">
1118 <summary>
1119 Indicates whether the head revision should be used if the
1120 <see cref="P:NAnt.SourceControl.Tasks.TagTask.ActOnTag"/> or the <see cref="P:NAnt.SourceControl.Tasks.TagTask.ActOnDate"/> tags are not
1121 found.
1122 </summary>
1123 <value>
1124 <see langword="true"/> if the specified tag should be moved;
1125 otherwise, <see langword="false"/>. The default is <see langword="false"/>.
1126 </value>
1127 </member>
1128 <member name="P:NAnt.SourceControl.Tasks.TagTask.CommandName">
1129 <summary>
1130 The name of the cvs command that is going to be executed.
1131 </summary>
1132 </member>
1133 <member name="P:NAnt.SourceControl.Tasks.TagTask.Module">
1134 <summary>
1135 Not used
1136 </summary>
1137 </member>
1138 <member name="P:NAnt.SourceControl.Tasks.TagTask.IsModuleNeeded">
1139 <summary>
1140 Specify if the module is needed for this cvs command. It is
1141 only needed if there is no module information on the local file
1142 system.
1143 </summary>
1144 </member>
1145 <member name="T:NAnt.SourceControl.Tasks.UpdateTask">
1146 <summary>
1147 Updates a CVS module in a local working directory.
1148 </summary>
1149 <example>
1150 <para>Update nant.</para>
1151 <code>
1152 <![CDATA[
1153 <cvs-update
1154 destination="c:\src\nant\"
1155 cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
1156 password=""
1157 module="nant" />
1158 ]]>
1159 </code>
1160 </example>
1161 <example>
1162 <para>
1163 Update your NAnt revision named <c>your_favorite_revision_here</c> in
1164 the folder <c>c:\src\nant\replacement_for_module_directory_name</c>.
1165 </para>
1166 <code>
1167 <![CDATA[
1168 <cvs-update
1169 destination="c:\src\nant\"
1170 cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
1171 module="nant"
1172 revision="your_favorite_revision_here"
1173 overridedir="replacement_for_module_directory_name"
1174 usesharpcvslib="false">
1175 <fileset>
1176 <include name="build.number"/>
1177 </fileset>
1178 </cvs-update>
1179 ]]>
1180 </code>
1181 </example>
1182 </member>
1183 <member name="F:NAnt.SourceControl.Tasks.UpdateTask.CvsCommandName">
1184 <summary>
1185 The command being executed.
1186 </summary>
1187 </member>
1188 <member name="M:NAnt.SourceControl.Tasks.UpdateTask.#ctor">
1189 <summary>
1190 Initializes a new instance of the <see cref="T:NAnt.SourceControl.Tasks.UpdateTask"/>
1191 class.
1192 </summary>
1193 <remarks>
1194 Sets the build directory and prune empty directory properties to
1195 <see langword="true"/>.
1196 </remarks>
1197 </member>
1198 <member name="P:NAnt.SourceControl.Tasks.UpdateTask.BuildDirs">
1199 <summary>
1200 If <see langword="true" />. new directories will be created on the local
1201 sandbox. The default is <see langword="true" />.
1202 </summary>
1203 </member>
1204 <member name="P:NAnt.SourceControl.Tasks.UpdateTask.PruneEmpty">
1205 <summary>
1206 If <see langword="true" /> empty directories copied down from the
1207 remote repository will be removed from the local sandbox.
1208 The default is <see langword="true" />.
1209 </summary>
1210 </member>
1211 <member name="P:NAnt.SourceControl.Tasks.UpdateTask.OverwriteLocal">
1212 <summary>
1213 If <see langword="true" /> the local copy of the file will be
1214 overwritten with the copy from the remote repository. The default
1215 is <see langword="false" />.
1216 </summary>
1217 </member>
1218 <member name="P:NAnt.SourceControl.Tasks.UpdateTask.Recursive">
1219 <summary>
1220 Specifies if the command should be executed recursively. The
1221 default is <see langword="true" />.
1222 </summary>
1223 <remarks>
1224 The <c>-R</c> option is on by default in cvs.
1225 </remarks>
1226 </member>
1227 <member name="P:NAnt.SourceControl.Tasks.UpdateTask.Revision">
1228 <summary>
1229 Specify the revision to update the file to. This corresponds to the
1230 "sticky-tag" of the file.
1231 </summary>
1232 </member>
1233 <member name="P:NAnt.SourceControl.Tasks.UpdateTask.StickyTag">
1234 <summary>
1235 Sticky tag or revision to update the local file to.
1236 </summary>
1237 <value>
1238 A valid cvs tag.
1239 </value>
1240 </member>
1241 <member name="P:NAnt.SourceControl.Tasks.UpdateTask.Date">
1242 <summary>
1243 Specify the revision date to update to. The version of the file that
1244 existed at the date specified is retrieved.
1245 </summary>
1246 <value>
1247 A valid date time value, which is then converted to a format that
1248 cvs can parse.
1249 </value>
1250 </member>
1251 <member name="P:NAnt.SourceControl.Tasks.UpdateTask.IsModuleNeeded">
1252 <summary>
1253 Specify if the module is needed for this cvs command. It is
1254 only needed if there is no module information on the local file
1255 system.
1256 </summary>
1257 </member>
1258 <member name="P:NAnt.SourceControl.Tasks.UpdateTask.CommandName">
1259 <summary>
1260 The name of the cvs command that is going to be executed.
1261 </summary>
1262 </member>
1263 <member name="T:NAnt.SourceControl.Types.CvsFileSet">
1264 <summary>
1265 A <see cref="T:NAnt.SourceControl.Types.CvsFileSet"/> is a <see cref="T:NAnt.Core.Types.FileSet"/> with extra
1266 attributes useful in the context of the <see cref="T:NAnt.SourceControl.Tasks.CvsTask"/>.
1267 </summary>
1268 </member>
1269 <member name="M:NAnt.SourceControl.Types.CvsFileSet.Initialize">
1270 <summary>
1271 Initialize the <see cref="T:NAnt.SourceControl.Types.CvsFileSet"/> object and locate the .cvsignore
1272 files to add to the exclude list.
1273 </summary>
1274 </member>
1275 <member name="P:NAnt.SourceControl.Types.CvsFileSet.UseCvsIgnore">
1276 <summary>
1277 Indicates whether the entires in the .cvsignore should be used to limit the
1278 file list; <see langword="true"/> to exclude files in .cvsignore, otherwise
1279 <see langword="false"/>. The default is <see langword="true"/>.
1280 </summary>
1281 </member>
1282 </members>
1283</doc>