hgcia, convert: escape backslashes in docstrings

hgext/convert/__init__.py

@@ -1,274 +1,274 b''
 # convert.py Foreign SCM converter
 #
 # Copyright 2005-2007 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
 '''converting foreign VCS repositories to Mercurial'''
 
 import convcmd
 import cvsps
 import subversion
 from mercurial import commands
 from mercurial.i18n import _
 
 # Commands definition was moved elsewhere to ease demandload job.
 
 def convert(ui, src, dest=None, revmapfile=None, **opts):
     """convert a foreign SCM repository to a Mercurial one.
 
     Accepted source formats [identifiers]:
     - Mercurial [hg]
     - CVS [cvs]
     - Darcs [darcs]
     - git [git]
     - Subversion [svn]
     - Monotone [mtn]
     - GNU Arch [gnuarch]
     - Bazaar [bzr]
     - Perforce [p4]
 
     Accepted destination formats [identifiers]:
     - Mercurial [hg]
     - Subversion [svn] (history on branches is not preserved)
 
     If no revision is given, all revisions will be converted.
     Otherwise, convert will only import up to the named revision
     (given in a format understood by the source).
 
     If no destination directory name is specified, it defaults to the
     basename of the source with '-hg' appended. If the destination
     repository doesn't exist, it will be created.
 
     If <REVMAP> isn't given, it will be put in a default location
     (<dest>/.hg/shamap by default). The <REVMAP> is a simple text file
     that maps each source commit ID to the destination ID for that
     revision, like so:
     <source ID> <destination ID>
 
     If the file doesn't exist, it's automatically created. It's
     updated on each commit copied, so convert-repo can be interrupted
     and can be run repeatedly to copy new commits.
 
     The [username mapping] file is a simple text file that maps each
     source commit author to a destination commit author. It is handy
     for source SCMs that use unix logins to identify authors (eg:
     CVS). One line per author mapping and the line format is:
     srcauthor=whatever string you want
 
     The filemap is a file that allows filtering and remapping of files
     and directories. Comment lines start with '#'. Each line can
     contain one of the following directives:
 
       include path/to/file
 
       exclude path/to/file
 
       rename from/file to/file
 
     The 'include' directive causes a file, or all files under a
     directory, to be included in the destination repository, and the
     exclusion of all other files and directories not explicitely included.
     The 'exclude' directive causes files or directories to be omitted.
     The 'rename' directive renames a file or directory. To rename from
     a subdirectory into the root of the repository, use '.' as the
     path to rename to.
 
     The splicemap is a file that allows insertion of synthetic
     history, letting you specify the parents of a revision. This is
     useful if you want to e.g. give a Subversion merge two parents, or
     graft two disconnected series of history together. Each entry
     contains a key, followed by a space, followed by one or two
     comma-separated values. The key is the revision ID in the source
     revision control system whose parents should be modified (same
     format as a key in .hg/shamap). The values are the revision IDs
     (in either the source or destination revision control system) that
     should be used as the new parents for that node.
 
     The branchmap is a file that allows you to rename a branch when it is
     being brought in from whatever external repository. When used in
     conjunction with a splicemap, it allows for a powerful combination
     to help fix even the most badly mismanaged repositories and turn them
     into nicely structured Mercurial repositories. The branchmap contains
     lines of the form "original_branch_name new_branch_name".
     "original_branch_name" is the name of the branch in the source
     repository, and "new_branch_name" is the name of the branch is the
     destination repository. This can be used to (for instance) move code
     in one repository from "default" to a named branch.
 
     Mercurial Source
     -----------------
 
     --config convert.hg.ignoreerrors=False    (boolean)
         ignore integrity errors when reading. Use it to fix Mercurial
         repositories with missing revlogs, by converting from and to
         Mercurial.
     --config convert.hg.saverev=False         (boolean)
         store original revision ID in changeset (forces target IDs to
         change)
     --config convert.hg.startrev=0            (hg revision identifier)
         convert start revision and its descendants
 
     CVS Source
     ----------
 
     CVS source will use a sandbox (i.e. a checked-out copy) from CVS
     to indicate the starting point of what will be converted. Direct
     access to the repository files is not needed, unless of course the
     repository is :local:. The conversion uses the top level directory
     in the sandbox to find the CVS repository, and then uses CVS rlog
     commands to find files to convert. This means that unless a
     filemap is given, all files under the starting directory will be
     converted, and that any directory reorganisation in the CVS
     sandbox is ignored.
 
     Because CVS does not have changesets, it is necessary to collect
     individual commits to CVS and merge them into changesets. CVS
     source uses its internal changeset merging code by default but can
     be configured to call the external 'cvsps' program by setting:
         --config convert.cvsps='cvsps -A -u --cvs-direct -q'
     This is a legacy option and may be removed in future.
 
     The options shown are the defaults.
 
     Internal cvsps is selected by setting
         --config convert.cvsps=builtin
     and has a few more configurable options:
         --config convert.cvsps.cache=True     (boolean)
             Set to False to disable remote log caching, for testing and
             debugging purposes.
         --config convert.cvsps.fuzz=60        (integer)
             Specify the maximum time (in seconds) that is allowed
             between commits with identical user and log message in a
             single changeset. When very large files were checked in as
             part of a changeset then the default may not be long
             enough.
-        --config convert.cvsps.mergeto='{{mergetobranch ([-\w]+)}}'
+        --config convert.cvsps.mergeto='{{mergetobranch ([-\\w]+)}}'
             Specify a regular expression to which commit log messages
             are matched. If a match occurs, then the conversion
             process will insert a dummy revision merging the branch on
             which this log message occurs to the branch indicated in
             the regex.
-        --config convert.cvsps.mergefrom='{{mergefrombranch ([-\w]+)}}'
+        --config convert.cvsps.mergefrom='{{mergefrombranch ([-\\w]+)}}'
             Specify a regular expression to which commit log messages
             are matched. If a match occurs, then the conversion
             process will add the most recent revision on the branch
             indicated in the regex as the second parent of the
             changeset.
 
     The hgext/convert/cvsps wrapper script allows the builtin
     changeset merging code to be run without doing a conversion. Its
     parameters and output are similar to that of cvsps 2.1.
 
     Subversion Source
     -----------------
 
     Subversion source detects classical trunk/branches/tags layouts.
     By default, the supplied "svn://repo/path/" source URL is
     converted as a single branch. If "svn://repo/path/trunk" exists it
     replaces the default branch. If "svn://repo/path/branches" exists,
     its subdirectories are listed as possible branches. If
     "svn://repo/path/tags" exists, it is looked for tags referencing
     converted branches. Default "trunk", "branches" and "tags" values
     can be overriden with following options. Set them to paths
     relative to the source URL, or leave them blank to disable
     autodetection.
 
     --config convert.svn.branches=branches    (directory name)
         specify the directory containing branches
     --config convert.svn.tags=tags            (directory name)
         specify the directory containing tags
     --config convert.svn.trunk=trunk          (directory name)
         specify the name of the trunk branch
 
     Source history can be retrieved starting at a specific revision,
     instead of being integrally converted. Only single branch
     conversions are supported.
 
     --config convert.svn.startrev=0           (svn revision number)
         specify start Subversion revision.
 
     Perforce Source
     ---------------
 
     The Perforce (P4) importer can be given a p4 depot path or a
     client specification as source. It will convert all files in the
     source to a flat Mercurial repository, ignoring labels, branches
     and integrations. Note that when a depot path is given you then
     usually should specify a target directory, because otherwise the
     target may be named ...-hg.
 
     It is possible to limit the amount of source history to be
     converted by specifying an initial Perforce revision.
 
     --config convert.p4.startrev=0            (perforce changelist number)
         specify initial Perforce revision.
 
 
     Mercurial Destination
     ---------------------
 
     --config convert.hg.clonebranches=False   (boolean)
         dispatch source branches in separate clones.
     --config convert.hg.tagsbranch=default    (branch name)
         tag revisions branch name
     --config convert.hg.usebranchnames=True   (boolean)
         preserve branch names
 
     """
     return convcmd.convert(ui, src, dest, revmapfile, **opts)
 
 def debugsvnlog(ui, **opts):
     return subversion.debugsvnlog(ui, **opts)
 
 def debugcvsps(ui, *args, **opts):
     '''create changeset information from CVS
 
     This command is intended as a debugging tool for the CVS to
     Mercurial converter, and can be used as a direct replacement for
     cvsps.
 
     Hg debugcvsps reads the CVS rlog for current directory (or any
     named directory) in the CVS repository, and converts the log to a
     series of changesets based on matching commit log entries and
     dates.'''
     return cvsps.debugcvsps(ui, *args, **opts)
 
 commands.norepo += " convert debugsvnlog debugcvsps"
 
 cmdtable = {
     "convert":
         (convert,
          [('A', 'authors', '', _('username mapping filename')),
           ('d', 'dest-type', '', _('destination repository type')),
           ('', 'filemap', '', _('remap file names using contents of file')),
           ('r', 'rev', '', _('import up to target revision REV')),
           ('s', 'source-type', '', _('source repository type')),
           ('', 'splicemap', '', _('splice synthesized history into place')),
           ('', 'branchmap', '', _('change branch names while converting')),
           ('', 'datesort', None, _('try to sort changesets by date'))],
          _('hg convert [OPTION]... SOURCE [DEST [REVMAP]]')),
     "debugsvnlog":
         (debugsvnlog,
          [],
          'hg debugsvnlog'),
     "debugcvsps":
         (debugcvsps,
          [
           # Main options shared with cvsps-2.1
           ('b', 'branches', [], _('only return changes on specified branches')),
           ('p', 'prefix', '', _('prefix to remove from file names')),
           ('r', 'revisions', [], _('only return changes after or between specified tags')),
           ('u', 'update-cache', None, _("update cvs log cache")),
           ('x', 'new-cache', None, _("create new cvs log cache")),
           ('z', 'fuzz', 60, _('set commit time fuzz in seconds')),
           ('', 'root', '', _('specify cvsroot')),
           # Options specific to builtin cvsps
           ('', 'parents', '', _('show parent changesets')),
           ('', 'ancestors', '', _('show current changeset in ancestor branches')),
           # Options that are ignored for compatibility with cvsps-2.1
           ('A', 'cvs-direct', None, _('ignored for compatibility')),
          ],
          _('hg debugcvsps [OPTION]... [PATH]...')),
 }

hgext/hgcia.py

@@ -1,246 +1,246 b''
 # Copyright (C) 2007-8 Brendan Cully <[e-mail]>
 # Published under the GNU GPL
 
 """CIA notification
 
 This is meant to be run as a changegroup or incoming hook.
 To configure it, set the following options in your hgrc:
 
 [cia]
 # your registered CIA user name
 user = foo
 # the name of the project in CIA
 project = foo
 # the module (subproject) (optional)
 #module = foo
 # Append a diffstat to the log message (optional)
 #diffstat = False
 # Template to use for log messages (optional)
-#template = {desc}\n{baseurl}/rev/{node}-- {diffstat}
+#template = {desc}\\n{baseurl}/rev/{node}-- {diffstat}
 # Style to use (optional)
 #style = foo
 # The URL of the CIA notification service (optional)
 # You can use mailto: URLs to send by email, eg
 # mailto:[e-mail]
 # Make sure to set email.from if you do this.
 #url = http://cia.vc/
 # print message instead of sending it (optional)
 #test = False
 
 [hooks]
 # one of these:
 changegroup.cia = python:hgcia.hook
 #incoming.cia = python:hgcia.hook
 
 [web]
 # If you want hyperlinks (optional)
 baseurl = http://server/path/to/repo
 """
 
 from mercurial.i18n import _
 from mercurial.node import *
 from mercurial import cmdutil, patch, templater, util, mail
 import email.Parser
 
 import xmlrpclib
 from xml.sax import saxutils
 
 socket_timeout = 30 # seconds
 try:
     # set a timeout for the socket so you don't have to wait so looooong
     # when cia.vc is having problems. requires python >= 2.3:
     import socket
     socket.setdefaulttimeout(socket_timeout)
 except:
     pass
 
 HGCIA_VERSION = '0.1'
 HGCIA_URL = 'http://hg.kublai.com/mercurial/hgcia'
 
 
 class ciamsg(object):
     """ A CIA message """
     def __init__(self, cia, ctx):
         self.cia = cia
         self.ctx = ctx
         self.url = self.cia.url
 
     def fileelem(self, path, uri, action):
         if uri:
             uri = ' uri=%s' % saxutils.quoteattr(uri)
         return '<file%s action=%s>%s</file>' % (
             uri, saxutils.quoteattr(action), saxutils.escape(path))
 
     def fileelems(self):
         n = self.ctx.node()
         f = self.cia.repo.status(self.ctx.parents()[0].node(), n)
         url = self.url or ''
         elems = []
         for path in f[0]:
             uri = '%s/diff/%s/%s' % (url, short(n), path)
             elems.append(self.fileelem(path, url and uri, 'modify'))
         for path in f[1]:
             # TODO: copy/rename ?
             uri = '%s/file/%s/%s' % (url, short(n), path)
             elems.append(self.fileelem(path, url and uri, 'add'))
         for path in f[2]:
             elems.append(self.fileelem(path, '', 'remove'))
 
         return '\n'.join(elems)
 
     def sourceelem(self, project, module=None, branch=None):
         msg = ['<source>', '<project>%s</project>' % saxutils.escape(project)]
         if module:
             msg.append('<module>%s</module>' % saxutils.escape(module))
         if branch:
             msg.append('<branch>%s</branch>' % saxutils.escape(branch))
         msg.append('</source>')
 
         return '\n'.join(msg)
 
     def diffstat(self):
         class patchbuf:
             def __init__(self):
                 self.lines = []
                 # diffstat is stupid
                 self.name = 'cia'
             def write(self, data):
                 self.lines.append(data)
             def close(self):
                 pass
 
         n = self.ctx.node()
         pbuf = patchbuf()
         patch.export(self.cia.repo, [n], fp=pbuf)
         return patch.diffstat(pbuf.lines) or ''
 
     def logmsg(self):
         diffstat = self.cia.diffstat and self.diffstat() or ''
         self.cia.ui.pushbuffer()
         self.cia.templater.show(self.ctx, changes=self.ctx.changeset(),
                                 url=self.cia.url, diffstat=diffstat)
         return self.cia.ui.popbuffer()
 
     def xml(self):
         n = short(self.ctx.node())
         src = self.sourceelem(self.cia.project, module=self.cia.module,
                               branch=self.ctx.branch())
         # unix timestamp
         dt = self.ctx.date()
         timestamp = dt[0]
 
         author = saxutils.escape(self.ctx.user())
         rev = '%d:%s' % (self.ctx.rev(), n)
         log = saxutils.escape(self.logmsg())
 
         url = self.url and '<url>%s/rev/%s</url>' % (saxutils.escape(self.url),
                                                      n) or ''
 
         msg = """
 <message>
   <generator>
     <name>Mercurial (hgcia)</name>
     <version>%s</version>
     <url>%s</url>
     <user>%s</user>
   </generator>
   %s
   <body>
     <commit>
       <author>%s</author>
       <version>%s</version>
       <log>%s</log>
       %s
       <files>%s</files>
     </commit>
   </body>
   <timestamp>%d</timestamp>
 </message>
 """ % \
             (HGCIA_VERSION, saxutils.escape(HGCIA_URL),
             saxutils.escape(self.cia.user), src, author, rev, log, url,
             self.fileelems(), timestamp)
 
         return msg
 
 
 class hgcia(object):
     """ CIA notification class """
 
     deftemplate = '{desc}'
     dstemplate = '{desc}\n-- \n{diffstat}'
 
     def __init__(self, ui, repo):
         self.ui = ui
         self.repo = repo
 
         self.ciaurl = self.ui.config('cia', 'url', 'http://cia.vc')
         self.user = self.ui.config('cia', 'user')
         self.project = self.ui.config('cia', 'project')
         self.module = self.ui.config('cia', 'module')
         self.diffstat = self.ui.configbool('cia', 'diffstat')
         self.emailfrom = self.ui.config('email', 'from')
         self.dryrun = self.ui.configbool('cia', 'test')
         self.url = self.ui.config('web', 'baseurl')
 
         style = self.ui.config('cia', 'style')
         template = self.ui.config('cia', 'template')
         if not template:
             template = self.diffstat and self.dstemplate or self.deftemplate
         template = templater.parsestring(template, quoted=False)
         t = cmdutil.changeset_templater(self.ui, self.repo, False, None,
                                         style, False)
         t.use_template(template)
         self.templater = t
 
     def sendrpc(self, msg):
         srv = xmlrpclib.Server(self.ciaurl)
         srv.hub.deliver(msg)
 
     def sendemail(self, address, data):
         p = email.Parser.Parser()
         msg = p.parsestr(data)
         msg['Date'] = util.datestr(format="%a, %d %b %Y %H:%M:%S %1%2")
         msg['To'] = address
         msg['From'] = self.emailfrom
         msg['Subject'] = 'DeliverXML'
         msg['Content-type'] = 'text/xml'
         msgtext = msg.as_string(0)
 
         self.ui.status(_('hgcia: sending update to %s\n') % address)
         mail.sendmail(self.ui, util.email(self.emailfrom),
                       [address], msgtext)
 
 
 def hook(ui, repo, hooktype, node=None, url=None, **kwargs):
     """ send CIA notification """
     def sendmsg(cia, ctx):
         msg = ciamsg(cia, ctx).xml()
         if cia.dryrun:
             ui.write(msg)
         elif cia.ciaurl.startswith('mailto:'):
             if not cia.emailfrom:
                 raise util.Abort(_('email.from must be defined when '
                                    'sending by email'))
             cia.sendemail(cia.ciaurl[7:], msg)
         else:
             cia.sendrpc(msg)
 
     n = bin(node)
     cia = hgcia(ui, repo)
     if not cia.user:
         ui.debug(_('cia: no user specified'))
         return
     if not cia.project:
         ui.debug(_('cia: no project specified'))
         return
     if hooktype == 'changegroup':
         start = repo.changelog.rev(n)
         end = len(repo.changelog)
         for rev in xrange(start, end):
             n = repo.changelog.node(rev)
             ctx = repo.changectx(n)
             sendmsg(cia, ctx)
     else:
         ctx = repo.changectx(n)
         sendmsg(cia, ctx)