comparison __init__.py @ 332:56d877e6ccbb

__init__: rewrite extension docstring to be slightly less hostile.
author Dan Villiom Podlaski Christiansen <danchr@gmail.com>
date Tue, 19 May 2009 11:05:45 +0200
parents 75f082b5897e
children
comparison
equal deleted inserted replaced
331:75f082b5897e 332:56d877e6ccbb
1 '''integration with Subversion repositories 1 '''integration with Subversion repositories
2 2
3 This extension allows Mercurial to act as a Subversion client, for 3 hgsubversion is an extension for Mercurial that allows it to act as a Subversion
4 fast incremental, bidirectional updates. 4 client, offering fast, incremental and bidirectional synchronisation.
5 5
6 It is *not* ready yet for production use. You should only be using 6 Please note that hgsubversion should not be considered stable software. It is
7 this if you're ready to hack on it, and go diving into the internals 7 not feature complete, and neither guarantees of functionality nor future
8 of Mercurial and/or Subversion. 8 compatability can be offered. It is, however, quite useful for the cases where
9 it works, and a good platform for further improvements.
9 10
10 Before using hgsubversion, it is *strongly* encouraged to run the 11 Before using hgsubversion, we *strongly* encourage running the
11 automated tests. See `README' in the hgsubversion directory for 12 automated tests. See `README' in the hgsubversion directory for
12 details. 13 details.
14
15 The operation of hgsubversion can be customised with the following variables:
16
17 <list not written yet>
18
13 ''' 19 '''
14 # TODO: The docstring should be slightly more helpful, and at least mention all 20 # TODO: The docstring should be slightly more helpful, and at least mention all
15 # configuration settings we support 21 # configuration settings we support
16 22
17 import os 23 import os