dmitry@951: <?xml version="1.0" encoding="UTF-8"?>
dmitry@951: <!--
dmitry@951:   ~ Copyright 2000-2016 JetBrains s.r.o.
dmitry@951:   ~
dmitry@951:   ~ Licensed under the Apache License, Version 2.0 (the "License");
dmitry@951:   ~ you may not use this file except in compliance with the License.
dmitry@951:   ~ You may obtain a copy of the License at
dmitry@951:   ~
dmitry@951:   ~ http://www.apache.org/licenses/LICENSE-2.0
dmitry@951:   ~
dmitry@951:   ~ Unless required by applicable law or agreed to in writing, software
dmitry@951:   ~ distributed under the License is distributed on an "AS IS" BASIS,
dmitry@951:   ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
dmitry@951:   ~ See the License for the specific language governing permissions and
dmitry@951:   ~ limitations under the License.
dmitry@951:   -->
dmitry@951: 
dmitry@953: <dsl-extension kind="vcs" type="mercurial" generateDslJar="true">
dmitry@961:   <class name="HgVcsRoot">
dmitry@961:     <description>
dmitry@961:       Mercurial [VCS root](https://confluence.jetbrains.com/display/TCDL/Mercurial)
dmitry@961:     </description>
dmitry@961:   </class>
dmitry@951:   <params>
dmitry@961:     <param name="repositoryPath" dslName="url">
dmitry@961:       <description>
dmitry@961:         Mercurial repository URL
dmitry@961:       </description>
dmitry@961:     </param>
dmitry@961:     <param name="branchName" dslName="branch">
dmitry@961:       <description>
dmitry@961:         Default branch name
dmitry@961:       </description>
dmitry@961:     </param>
dmitry@961:     <param name="teamcity:branchSpec" dslName="branchSpec">
dmitry@961:       <description>
dmitry@961:         [Branch specification](https://confluence.jetbrains.com/display/TCDL/Working+with+Feature+Branches#WorkingwithFeatureBranches-branchSpec)
dmitry@961:         to use in VCS root
dmitry@961:       </description>
dmitry@961:     </param>
dmitry@961:     <param name="useTagsAsBranches" type="boolean">
dmitry@961:       <description>
dmitry@961:         Allows to use tags in branch specification. By default, tags are ignored.
dmitry@961:       </description>
dmitry@961:     </param>
dmitry@961:     <param name="detectSubrepoChanges" type="boolean">
dmitry@961:       <description>
dmitry@961:         Whether TeamCity should detect changes in submodules
dmitry@961:       </description>
dmitry@961:     </param>
dmitry@961:     <param name="tagUsername" dslName="userForTags">
dmitry@961:       <description>
dmitry@961:         A custom username for tags. Format: User Name &lt;email&gt;
dmitry@961:       </description>
dmitry@961:     </param>
dmitry@961:     <param name="uncompressedTransfer" type="boolean">
dmitry@961:       <description>
dmitry@961:         Whether the "--uncompressed" option should be added to the "hg clone" command.
dmitry@961:         It is enabled by default.
dmitry@961:       </description>
dmitry@961:     </param>
dmitry@961:     <param name="hgCommandPath" dslName="hgPath">
dmitry@961:       <description>
dmitry@961:         [Path](https://confluence.jetbrains.com/display/TCDL/Mercurial#Mercurial-hgDetection) to hg executable
dmitry@961:       </description>
dmitry@961:     </param>
dmitry@961:     <param name="customHgConfig">
dmitry@961:       <description>
dmitry@961:         Mercurial configuration options to be applied to the repository in the
dmitry@961:         standard [format](https://www.selenic.com/mercurial/hgrc.5.html)
dmitry@961:       </description>
dmitry@961:     </param>
dmitry@961:     <param name="username" dslName="userName">
dmitry@961:       <description>
dmitry@961:         A username for mercurial connection
dmitry@961:       </description>
dmitry@961:     </param>
dmitry@961:     <param name="secure:password" dslName="password">
dmitry@961:       <description>
dmitry@961:         A password for mercurial connection
dmitry@961:       </description>
dmitry@961:     </param>
dmitry@961:     <param name="purgePolicy" type="PurgePolicy">
dmitry@961:       <description>
dmitry@961:         Specifies whether TeamCity should run the [hg purge](https://www.mercurial-scm.org/wiki/PurgeExtension) command and what files should be purged
dmitry@961:         @see PurgePolicy
dmitry@961:       </description>
dmitry@961:     </param>
dmitry@961:     <param name="useSharedMirrors" dslName="useMirrors" type="boolean">
dmitry@961:       <description>
dmitry@961:         When set to true, TeamCity creates a local agent mirror first (under agent's system/mercurial directory) and then clones to the
dmitry@961:         build [checkout directory](https://confluence.jetbrains.com/display/TCDL/Build+Checkout+Directory) from this local mirror.
dmitry@961:         This option speeds up clean checkout, because only the build working directory is cleaned.
dmitry@961:         Also, if a single root is used in several build configurations, a clone will be faster.
dmitry@961:       </description>
dmitry@961:     </param>
dmitry@951:   </params>
dmitry@951:   <types>
dmitry@951:     <enum name="PurgePolicy">
dmitry@961:       <description>
dmitry@961:         Defines [hg purge](https://www.mercurial-scm.org/wiki/PurgeExtension) settings
dmitry@961:       </description>
dmitry@961:       <option name="DONT_RUN">
dmitry@961:         <description>
dmitry@961:           Don't run the "hg purge"
dmitry@961:         </description>
dmitry@961:       </option>
dmitry@961:       <option name="PURGE_UNKNOWN">
dmitry@961:         <description>
dmitry@961:           Purge unknown files and empty directories
dmitry@961:         </description>
dmitry@961:       </option>
dmitry@961:       <option name="PURGE_ALL">
dmitry@961:         <description>
dmitry@961:           Purge unknown files, empty directories, and ignored files. Runs "hg purge --all".
dmitry@961:         </description>
dmitry@961:       </option>
dmitry@951:     </enum>
dmitry@951:   </types>
dmitry@951: </dsl-extension>