Mercurial > hgsubversion
changeset 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 | a59ab58969d9 |
| files | __init__.py |
| diffstat | 1 files changed, 12 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/__init__.py +++ b/__init__.py @@ -1,15 +1,21 @@ '''integration with Subversion repositories -This extension allows Mercurial to act as a Subversion client, for -fast incremental, bidirectional updates. +hgsubversion is an extension for Mercurial that allows it to act as a Subversion +client, offering fast, incremental and bidirectional synchronisation. -It is *not* ready yet for production use. You should only be using -this if you're ready to hack on it, and go diving into the internals -of Mercurial and/or Subversion. +Please note that hgsubversion should not be considered stable software. It is +not feature complete, and neither guarantees of functionality nor future +compatability can be offered. It is, however, quite useful for the cases where +it works, and a good platform for further improvements. -Before using hgsubversion, it is *strongly* encouraged to run the +Before using hgsubversion, we *strongly* encourage running the automated tests. See `README' in the hgsubversion directory for details. + +The operation of hgsubversion can be customised with the following variables: + +<list not written yet> + ''' # TODO: The docstring should be slightly more helpful, and at least mention all # configuration settings we support