annotate hgsubversion/help/subversion.rst @ 659:55d6697b975a

help: add an rst file containing some helpful instructions The new file contains three sections: The first one is based on the README and contains instructions on how to use hgsubversion. The second one mentions the most notable shortcomings of hgsubversion. The third and final section documents how to customise hgsubversion.
author Dan Villiom Podlaski Christiansen <danchr@gmail.com>
date Wed, 11 Aug 2010 19:57:34 +0200
parents
children 703f33576ad8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
659
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
1 Basic Use
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
2 ---------
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
3
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
4 Converting a Subversion repository to Mercurial with hgsubversion is done by
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
5 cloning it. Subversion repositories are specified using the same, regular URL
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
6 syntax as Subversion uses. hgsubversion accepts URIs such as the following:
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
7
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
8 - http://user:sekrit@example.com/repo
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
9 - https://user@example.com/repo
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
10 - svn://example.com/repo
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
11 - svn+ssh://example.com/repo
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
12 - file:///tmp/repo
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
13
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
14 In the case of the two first schemas, HTTP and HTTPS, the repository is first
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
15 treated as a Mercurial repository, and a Subversion pull attempted should it
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
16 fail. As this can be particularly annoying for repositories that require
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
17 authentication, such repositories may also specified using a svn+http or
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
18 svn+https schema.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
19
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
20 To create a new Mercurial clone, you can use a command such as the following::
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
21
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
22 $ hg clone <repository URI> [destination]
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
23
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
24 Or with a real example::
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
25
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
26 $ hg clone http://python-nose.googlecode.com/svn nose-hg
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
27
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
28 Please note that there are two slightly different ways of cloning repositories:
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
29
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
30 The most common desire is to have the full history of a repository, including
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
31 all its tags and branches. In such cases you should clone from one level above
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
32 trunk, as in the example above. This is known as `standard layout`, and works
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
33 with repositories that use the conventional `trunk`, `tags` and `branches`
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
34 directories. By default, hgsubversion will use this layout whenever it finds any
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
35 of these directories at the specified directory on the server.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
36
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
37 If you instead want to clone just a single directory or branch, clone the
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
38 specific directory path. In the example above, to get *only* trunk, you would
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
39 issue :hg:`clone http://python-nose.googlecode.com/svn/trunk nose-trunk`. This
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
40 works with any directory with a Subversion repository, and is know as a single
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
41 directory clone.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
42
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
43 Pulling new revisions into an already-converted repo is the same as from any
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
44 other Mercurial source. Within the first example above, the following three
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
45 commands are all equivalent::
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
46
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
47 $ hg pull
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
48 $ hg pull default
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
49 $ hg pull http://python-nose.googlecode.com/svn
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
50
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
51 Sometimes, past repository history is of little or no interest, and all that is
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
52 wanted is access to current and future history from Mercurial. The --startrev
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
53 option with the HEAD argument causes the initial clone to only convert the
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
54 latest revision; later pulls will convert all revisions following the first.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
55 Please note that this only works for single-directory clones.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
56
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
57 Support for externals
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
58 -----------------------------
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
59
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
60 All ``svn:externals`` properties are serialized into a single
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
61 ``.hgsvnexternals`` file having the following syntax::
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
62
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
63 [.]
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
64 common1 http://path/to/external/svn/repo1
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
65 ...additional svn:externals properties lines...
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
66 [dir2]
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
67 common2 -r123 http://path/to/external/svn/repo2
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
68 ...additional svn:externals properties lines...
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
69
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
70 A header line in brackets specifies the directory the property applies
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
71 to, where '.' indicates the project root directory. The property content
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
72 follows the header, with every content line being prefixed by a single
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
73 space. Note that the property lines have a format identical to
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
74 svn:externals properties as used in Subversion, and do not support the
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
75 hgsubversion extended svn+http:// URL format.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
76
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
77 Issuing the command :hg:`svn updateexternals` with the ``.hgsvnexternals``
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
78 example above would fetch the latest revision of repo1 into the subdirectory
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
79 *./common1*, and revision 123 of repo2 into *dir2/common2*. Note that
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
80 ``.hgsvnexternals`` must be tracked by Mercurial before this will work. If
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
81 ``.hgsvnexternals`` is created or changed, it
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
82 will not be pushed to the related Subversion repository, but its
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
83 contents **will** be used to update ``svn:externals`` properties on the
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
84 related Subversion repository.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
85
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
86 Limitations
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
87 -----------
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
88
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
89 Currently, pushing to Subversion destroys the original changesets and replaces
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
90 them with new ones converted from the resulting commits. Due to the intricacies
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
91 of Subversion semantics, these converted changesets may differ in subtle ways
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
92 from the original Mercurial changests. For example, the commit date almost
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
93 always changes. This makes hgsubversion unsuitable for use as a two-way bridge.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
94
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
95 When converting from Subversion, hgsubversion does not recognize merge-info, and
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
96 does not create merges based on it. Similarly, Mercurial merges cannot be pushed
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
97 to Subversion.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
98
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
99 Changesets that create tags cannot be pushed to Subversion, as support for
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
100 creating Subversion tags has not been implemented, yet.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
101
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
102 Standard layout does not work with repositories that use unconventional
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
103 layouts. Thus, only a single directory clones can be made of such repositories.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
104
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
105 When interacting with Subversion, hgsubversion relies on information about the
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
106 previously converted changesets. This information will not be updated if pushing
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
107 or pulling converted changesets to or from any other source. To regenerate the
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
108 stored metadata, run :hg:`svn rebuildmeta [URI]`. This must also be done if any
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
109 converted changesets are ever removed from the repository.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
110
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
111 It is not possible to interact with more than one Subversion repository per
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
112 Mercurial clone. Please note that this also applies to more than one path within
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
113 a repository.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
114
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
115 Advanced Configuration
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
116 ----------------------
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
117
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
118 The operation of hgsubversion can be customized by the following configuration
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
119 settings:
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
120
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
121 hgsubversion.authormap
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
122 Path to a file for mapping usernames from Subversion to Mercurial. For
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
123 example::
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
124
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
125 joe = Joe User <joe@example.com>
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
126
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
127 hgsubversion.defaulthost
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
128 This option specifies the hostname to append to unmapped Subversion
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
129 usernames. The default is to append the UUID of the Subversion repository
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
130 as a hostname. That is, an author of `bob` may be mapped to
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
131 `bob@0b1d8996-7ded-4192-9199-38e2bec458fb`.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
132
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
133 If this option set to an empty string, the Subversion authors will be used
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
134 with no hostname component.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
135
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
136 hgsubversion.defaultauthors
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
137 Setting this boolean option to true will cause hgsubversion to abort a
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
138 conversion if a revision has an author not listed in the author map.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
139
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
140 hgsubversion.branchmap
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
141 Path to a file for changing branch names during the conversion from
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
142 Subversion to Mercurial.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
143
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
144 hgsubversion.filemap
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
145 Path to a file for filtering files during the conversion. Files may either
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
146 be excluded or included. See the documentation for :hg:`convert` for more
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
147 information on filemaps.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
148
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
149 hgsubversion.username, hgsubversion.password
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
150 Set the username or password for accessing Subversion repositories.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
151
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
152 hgsubversion.stupid
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
153 Setting this boolean option to true will force using a slower method for
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
154 pulling revisions from Subversion. This method is compatible with servers
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
155 using very old versions of Subversion, and hgsubversion falls back to it
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
156 when necessary.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
157
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
158 The following options only have an effect on the initial clone of a repository:
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
159
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
160 hgsubversion.layout
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
161 Set the layout of the repository. `standard` assumes a normal
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
162 trunk/branches/tags layout. `single` means that the entire repository is
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
163 converted into a single branch. The default, `auto`, causes hgsubversion to
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
164 assume a standard layout if any of trunk, branches, or tags exist within the
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
165 specified directory on the server.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
166
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
167 hgsubversion.startrev
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
168 Convert Subversion revisions starting at the one specified, either an
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
169 integer revision or HEAD; HEAD causes only the latest revision to be pulled.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
170 The default is to pull everything.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
171
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
172 hgsubversion.tagpaths
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
173 Specifies one or more paths in the Subversion repository that
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
174 contain tags. The default is to only look in `tags`. This option has no
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
175 effect for single-directory clones.
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
176
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
177 Please note that some of these options may be specified as command line options
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
178 as well, and when done so, will override the configuration. If an authormap,
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
179 filemap or branchmap is specified, its contents will be read and stored for use
55d6697b975a help: add an rst file containing some helpful instructions
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents:
diff changeset
180 in future pulls.