comparison mercurial-dsl/HgVcsRoot.xml @ 961:075f3521bd02

documenting dsl
author Dmitry Neverov <dmitry.neverov@gmail.com>
date Wed, 05 Apr 2017 10:36:29 +0200
parents ef995b1ed5ec
children ea15ebd45ba4 38adef4f1b8f
comparison
equal deleted inserted replaced
960:1aaf8dba4072 961:075f3521bd02
14 ~ See the License for the specific language governing permissions and 14 ~ See the License for the specific language governing permissions and
15 ~ limitations under the License. 15 ~ limitations under the License.
16 --> 16 -->
17 17
18 <dsl-extension kind="vcs" type="mercurial" generateDslJar="true"> 18 <dsl-extension kind="vcs" type="mercurial" generateDslJar="true">
19 <class name="HgVcsRoot"/> 19 <class name="HgVcsRoot">
20 <description>
21 Mercurial [VCS root](https://confluence.jetbrains.com/display/TCDL/Mercurial)
22 </description>
23 </class>
20 <params> 24 <params>
21 <param name="repositoryPath" dslName="url"/> 25 <param name="repositoryPath" dslName="url">
22 <param name="branchName" dslName="branch"/> 26 <description>
23 <param name="teamcity:branchSpec" dslName="branchSpec"/> 27 Mercurial repository URL
24 <param name="useTagsAsBranches" type="boolean"/> 28 </description>
25 <param name="detectSubrepoChanges" type="boolean"/> 29 </param>
26 <param name="tagUsername" dslName="userForTags"/> 30 <param name="branchName" dslName="branch">
27 <param name="uncompressedTransfer" type="boolean"/> 31 <description>
28 <param name="hgCommandPath" dslName="hgPath"/> 32 Default branch name
29 <param name="customHgConfig"/> 33 </description>
30 <param name="username" dslName="userName"/> 34 </param>
31 <param name="secure:password" dslName="password"/> 35 <param name="teamcity:branchSpec" dslName="branchSpec">
32 <param name="purgePolicy" type="PurgePolicy"/> 36 <description>
33 <param name="useSharedMirrors" dslName="useMirrors" type="boolean"/> 37 [Branch specification](https://confluence.jetbrains.com/display/TCDL/Working+with+Feature+Branches#WorkingwithFeatureBranches-branchSpec)
38 to use in VCS root
39 </description>
40 </param>
41 <param name="useTagsAsBranches" type="boolean">
42 <description>
43 Allows to use tags in branch specification. By default, tags are ignored.
44 </description>
45 </param>
46 <param name="detectSubrepoChanges" type="boolean">
47 <description>
48 Whether TeamCity should detect changes in submodules
49 </description>
50 </param>
51 <param name="tagUsername" dslName="userForTags">
52 <description>
53 A custom username for tags. Format: User Name &lt;email&gt;
54 </description>
55 </param>
56 <param name="uncompressedTransfer" type="boolean">
57 <description>
58 Whether the "--uncompressed" option should be added to the "hg clone" command.
59 It is enabled by default.
60 </description>
61 </param>
62 <param name="hgCommandPath" dslName="hgPath">
63 <description>
64 [Path](https://confluence.jetbrains.com/display/TCDL/Mercurial#Mercurial-hgDetection) to hg executable
65 </description>
66 </param>
67 <param name="customHgConfig">
68 <description>
69 Mercurial configuration options to be applied to the repository in the
70 standard [format](https://www.selenic.com/mercurial/hgrc.5.html)
71 </description>
72 </param>
73 <param name="username" dslName="userName">
74 <description>
75 A username for mercurial connection
76 </description>
77 </param>
78 <param name="secure:password" dslName="password">
79 <description>
80 A password for mercurial connection
81 </description>
82 </param>
83 <param name="purgePolicy" type="PurgePolicy">
84 <description>
85 Specifies whether TeamCity should run the [hg purge](https://www.mercurial-scm.org/wiki/PurgeExtension) command and what files should be purged
86 @see PurgePolicy
87 </description>
88 </param>
89 <param name="useSharedMirrors" dslName="useMirrors" type="boolean">
90 <description>
91 When set to true, TeamCity creates a local agent mirror first (under agent's system/mercurial directory) and then clones to the
92 build [checkout directory](https://confluence.jetbrains.com/display/TCDL/Build+Checkout+Directory) from this local mirror.
93 This option speeds up clean checkout, because only the build working directory is cleaned.
94 Also, if a single root is used in several build configurations, a clone will be faster.
95 </description>
96 </param>
34 </params> 97 </params>
35 <types> 98 <types>
36 <enum name="PurgePolicy"> 99 <enum name="PurgePolicy">
37 <option name="DONT_RUN"/> 100 <description>
38 <option name="PURGE_UNKNOWN"/> 101 Defines [hg purge](https://www.mercurial-scm.org/wiki/PurgeExtension) settings
39 <option name="PURGE_ALL"/> 102 </description>
103 <option name="DONT_RUN">
104 <description>
105 Don't run the "hg purge"
106 </description>
107 </option>
108 <option name="PURGE_UNKNOWN">
109 <description>
110 Purge unknown files and empty directories
111 </description>
112 </option>
113 <option name="PURGE_ALL">
114 <description>
115 Purge unknown files, empty directories, and ignored files. Runs "hg purge --all".
116 </description>
117 </option>
40 </enum> 118 </enum>
41 </types> 119 </types>
42 </dsl-extension> 120 </dsl-extension>