diff __init__.py @ 185:57355b0e7bd1

Creating patch for documention messages.
author Dan Villiom Podlaski Christiansen <danchr@cs.au.dk>
date Sat, 17 Jan 2009 15:30:37 -0600
parents a336e3e82648
children 91db8fc049b0
line wrap: on
line diff
--- a/__init__.py
+++ b/__init__.py
@@ -1,3 +1,17 @@
+'''integration with Subversion repositories
+
+This extension allows Mercurial to act as a Subversion client, for
+fast incremental, bidirectional updates.
+
+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.
+
+Before using hgsubversion, it is *strongly* encouraged to run the
+automated tests. See `README' in the hgsubversion directory for
+details.
+'''
+
 import os
 
 from mercurial import commands
@@ -16,10 +30,12 @@ def reposetup(ui, repo):
 
 
 def svn(ui, repo, subcommand, *args, **opts):
+    '''see detailed help for list of subcommands'''
+
     return svncommand.svncmd(ui, repo, subcommand, *args, **opts)
 
 def svn_fetch(ui, svn_url, hg_repo_path=None, **opts):
-    '''Clone Subversion repository to local Mercurial repository.
+    '''clone Subversion repository to a local Mercurial repository.
 
     If no destination directory name is specified, it defaults to the
     basename of the source plus "-hg".
@@ -42,20 +58,22 @@ commands.norepo += " svnclone"
 cmdtable = {
     "svn":
         (svn,
-         [('u', 'svn-url', '', 'Path to the Subversion server.'),
-          ('', 'stupid', False, 'Be stupid and use diffy replay.'),
+         [('u', 'svn-url', '', 'path to the Subversion server.'),
+          ('', 'stupid', False, 'be stupid and use diffy replay.'),
           ('A', 'authors', '', 'username mapping filename'),
-          ('', 'filemap', '', 'remap file to exclude paths or include only certain paths'),
+          ('', 'filemap', '',
+           'remap file to exclude paths or include only certain paths'),
           ],
          svncommand.generate_help(),
          ),
     "svnclone":
         (svn_fetch,
-         [('S', 'skipto-rev', '0', 'Skip commits before this revision.'),
-          ('', 'stupid', False, 'Be stupid and use diffy replay.'),
+         [('S', 'skipto-rev', '0', 'skip commits before this revision.'),
+          ('', 'stupid', False, 'be stupid and use diffy replay.'),
           ('T', 'tag-locations', 'tags', 'Relative path to Subversion tags.'),
           ('A', 'authors', '', 'username mapping filename'),
-          ('', 'filemap', '', 'remap file to exclude paths or include only certain paths'),
+          ('', 'filemap', '',
+           'remap file to exclude paths or include only certain paths'),
          ],
          'hg svnclone source [dest]'),
 }