Mercurial > hgsubversion
comparison README @ 662:a8d5eec1326b
README: remove usage instructions, and refer to the help topic instead.
The diff for the change can be somewhat hard to read, but all it does
is replace the `Basic Use' and `Support for svn:externals' sections
with the following section:
Further Reading
---------------
More information on how to use hgsubversion is available from within Mercurial
in the `subversion` help topic. To view it, use::
$ hg help subversion
The Restructured Text source for this topic is also available in the file
``hgsubverson/help/subversion.rst``.
| author | Dan Villiom Podlaski Christiansen <danchr@gmail.com> |
|---|---|
| date | Wed, 11 Aug 2010 19:57:34 +0200 |
| parents | f12257bf8b91 |
| children | 0b4e323ebedd |
comparison
equal
deleted
inserted
replaced
| 661:d0692ce98ea6 | 662:a8d5eec1326b |
|---|---|
| 36 there's a lot of stdout spew in the tests right now. The important | 36 there's a lot of stdout spew in the tests right now. The important |
| 37 part is that all the tests pass. | 37 part is that all the tests pass. |
| 38 | 38 |
| 39 .. _nose: http://code.google.com/p/python-nose/ | 39 .. _nose: http://code.google.com/p/python-nose/ |
| 40 | 40 |
| 41 Basic Use | 41 Further Reading |
| 42 ----------- | 42 --------------- |
| 43 Get a new clone of an svn server:: | |
| 44 | 43 |
| 45 $ hg clone <svn URI> [destination] | 44 More information on how to use hgsubversion is available from within Mercurial |
| 45 in the `subversion` help topic. To view it, use:: | |
| 46 | 46 |
| 47 Real example:: | 47 $ hg help subversion |
| 48 | 48 |
| 49 $ hg clone http://python-nose.googlecode.com/svn nose-hg | 49 The Restructured Text source for this topic is also available in the file |
| 50 | 50 ``hgsubverson/help/subversion.rst``. |
| 51 Note: there are two slightly different ways of cloning | |
| 52 repositories. The most common desire is to have all the | |
| 53 branches/tags/trunk from the svn repo, in which case you should clone | |
| 54 from one level above trunk (as in the example above.) If you instead | |
| 55 want to clone just a single directory rather than the complete | |
| 56 branches/tags/trunk structure of the repo, clone the specific | |
| 57 directory path. In the example above, to get *only* trunk, you would | |
| 58 clone `http://python-nose.googlecode.com/svn/trunk`. | |
| 59 | |
| 60 Pull new revisions into an already-converted repo:: | |
| 61 | |
| 62 $ hg pull | |
| 63 | |
| 64 For more information, see ``hg help svn`` while in a converted repo. | |
| 65 | |
| 66 Support for ``svn:externals`` | |
| 67 ----------------------------- | |
| 68 All ``svn:externals`` properties are serialized into a single | |
| 69 ``.hgsvnexternals`` file having the following syntax:: | |
| 70 | |
| 71 [.] | |
| 72 common1 http://path/to/external/svn/repo1 | |
| 73 ...additional svn:externals properties lines... | |
| 74 [dir2] | |
| 75 common2 -r123 http://path/to/external/svn/repo2 | |
| 76 ...additional svn:externals properties lines... | |
| 77 | |
| 78 A header line in brackets specifies the directory the property applies | |
| 79 to, where '.' indicates the project root directory. The property content | |
| 80 follows the header, **with every content line being prefixed by a single | |
| 81 space**. Note that the property lines have a format identical to | |
| 82 svn:externals properties as used in Subversion, and do not support the | |
| 83 hgsubversion extended svn+http:// URL format. | |
| 84 | |
| 85 Issuing the command ``hg svn updateexternals`` with the | |
| 86 ``.hgsvnexternals`` example above would fetch the latest revision of | |
| 87 repo1 into the subdirectory ./common1, and revision 123 of repo2 into | |
| 88 dir2/common2. Note that ``.hgsvnexternals`` must be tracked by Mercurial | |
| 89 before this will work. If ``.hgsvnexternals`` is created or changed, it | |
| 90 will not be pushed to the related Subversion repository, *but its | |
| 91 contents will be used to update ``svn:externals`` properties on the | |
| 92 related Subversion repository*. |
