evolve: comparison hgext/evolve.py

equal deleted inserted replaced

-:52c276d2ddb2
+:0c8548df67fe
 #####################################################################
 class exthelper(object):
 """Helper for modular extension setup
-A single helper should be instanciated for each extension. Helper
+A single helper should be instantiated for each extension. Helper
-methods are then used as decorator for various purpose.
+methods are then used as decorators for various purpose.
 All decorators return the original function and may be chained.
 """
 def __init__(self):
 try:
 histedit = extensions.find('histedit')
 if histedit:
 extensions.wrapcommand(histedit.cmdtable, 'histedit', warnobserrors)
 except KeyError:
-pass # rebase not found
+pass # histedit not found
 #####################################################################
 ### Old Evolve extension content                                  ###
 #####################################################################
 _deprecatealias('gup', 'next')
 _deprecatealias('gdown', 'previous')
 @command('debugrecordpruneparents', [], '')
 def cmddebugrecordpruneparents(ui, repo):
-"""add parents data to prune markers when possible
+"""add parent data to prune markers when possible
-This commands search the repo for prune markers without parent information.
+This command searches the repo for prune markers without parent information.
-If the pruned node is locally known, a new markers with parent data is
+If the pruned node is locally known, it creates a new marker with parent
-created."""
+data.
+"""
 pgop = 'reading markers'
 # lock from the beginning to prevent race
 wlock = lock = tr = None
 try:
 finally:
 lockmod.release(tr, lock, wlock)
 @command('debugobsstorestat', [], '')
 def cmddebugobsstorestat(ui, repo):
+"""print statistics about obsolescence markers in the repo"""
 def _updateclustermap(nodes, mark, clustersmap):
 c = (set(nodes), set([mark]))
 toproceed = set(nodes)
 while toproceed:
 n = toproceed.pop()
 continue
 clustersmap[on] = other
 c = other
 clustersmap[n] = c
-"""print statistic about obsolescence markers in the repo"""
 store = repo.obsstore
 unfi = repo.unfiltered()
 nm = unfi.changelog.nodemap
 ui.write(_('markers total:              %9i\n') % len(store._all))
 sucscount = [0, 0 , 0, 0]
 ui.progress(_('evolve'), None)
 if repo['.'] != startnode:
 ui.status(_('working directory is now at %s\n') % repo['.'])
 class MultipleSuccessorsError(RuntimeError):
-"""Exception raised by _singlesuccessor when multiple sucessors sets exists
+"""Exception raised by _singlesuccessor when multiple successor sets exists
 The object contains the list of successorssets in its 'successorssets'
 attribute to call to easily recover.
 """
 def _orderrevs(repo, revs):
 """Compute an ordering to solve instability for the given revs
-- Takes revs a list of instable revisions
+revs is a list of unstable revisions.
-- Returns the same revisions ordered to solve their instability from the
+Returns the same revisions ordered to solve their instability from the
 bottom to the top of the stack that the stabilization process will produce
 eventually.
-This ensure the minimal number of stabilization as we can stabilize each
+This ensures the minimal number of stabilizations, as we can stabilize each
-revision on its final, stabilized, destination.
+revision on its final stabilized destination.
 """
 # Step 1: Build the dependency graph
 dependencies, rdependencies = builddependencies(repo, revs)
 # Step 2: Build the ordering
 # Remove the revisions with no dependency(A) and add them to the ordering.
 result.add(unstable)
 return sorted(result - target)
 def _solveunstable(ui, repo, orig, dryrun=False, confirm=False,
 progresscb=None):
-"""Stabilize a unstable changeset"""
+"""Stabilize an unstable changeset"""
 obs = orig.parents()[0]
 if not obs.obsolete() and len(orig.parents()) == 2:
 obs = orig.parents()[1] # second parent is obsolete ?
 if not obs.obsolete():
 ('', 'merge', False, _('bring uncommitted change along')),
 ('n', 'dry-run', False,
 _('do not perform actions, just print what would be done'))],
 '[OPTION]...')
 def cmdprevious(ui, repo, **opts):
-"""update to parent and display summary lines"""
+"""update to parent revision
+Displays the summary line of the destination for clarity."""
 wkctx = repo[None]
 wparents = wkctx.parents()
 dryrunopt = opts['dry_run']
 if len(wparents) != 1:
 raise error.Abort('merge in progress')
 ('', 'evolve', False, _('evolve the next changeset if necessary')),
 ('n', 'dry-run', False,
 _('do not perform actions, just print what would be done'))],
 '[OPTION]...')
 def cmdnext(ui, repo, **opts):
-"""update to next child
+"""update to next child revision
-You can use the --evolve flag to get unstable children evolved on demand.
+Use the ``--evolve`` flag to evolve unstable children on demand.
-The summary line of the destination is displayed for clarity"""
+Displays the summary line of the destination for clarity.
+"""
 wkctx = repo[None]
 wparents = wkctx.parents()
 dryrunopt = opts['dry_run']
 if len(wparents) != 1:
 raise error.Abort('merge in progress')
 _('[OPTION] [-r] REV...'))
 # -U  --noupdate option to prevent wc update and or bookmarks update ?
 def cmdprune(ui, repo, *revs, **opts):
 """hide changesets by marking them obsolete
-Obsolete changesets becomes invisible to all commands.
+Pruned changesets are obsolete with no successors. If they also have no
+descendants, they are hidden (invisible to all commands).
-Unpruned descendants of pruned changesets becomes "unstable". Use the
-:hg:`evolve` to handle such situation.
+Non-obsolete descendants of pruned changesets become "unstable". Use :hg:`evolve`
+to handle this situation.
-When the working directory parent is pruned, the repository is updated to a
-non-obsolete parent.
+When you prune the parent of your working copy, Mercurial updates the working
+copy to a non-obsolete parent.
-You can use the ``--succ`` option to inform mercurial that a newer version
-of the pruned changeset exists.
+You can use ``--succ`` to tell Mercurial that a newer version (successor) of the
+pruned changeset exists. Mercurial records successor revisions in obsolescence
-You can use the ``--biject`` option to specify a 1-1 (bijection) between
+markers.
-revisions to prune and successor changesets. This option may be removed in
-a future release (with the functionality absorbed automatically).
+You can use the ``--biject`` option to specify a 1-1 mapping (bijection) between
+revisions to pruned (precursor) and successor changesets. This option may be
-If you specify multiple revisions in --succ, you are recording a "split"
+removed in a future release (with the functionality provided automatically).
-and have to acknowledge it by usng --split. The same logic apply when you
-prune multiple changesets with a single successors, this will record a
+If you specify multiple revisions in ``--succ``, you are recording a "split" and
-"fold" requires a --fold flag.
+must acknowledge it by passing ``--split``. Similarly, when you prune multiple
+changesets with a single successor, you must pass the ``--fold`` option.
 """
 revs = scmutil.revrange(repo, list(revs) + opts.get('rev'))
 succs = opts['new'] + opts['succ']
 bookmarks = set(opts.get('bookmark'))
 metadata = _getmetadata(**opts)
 @command('^split',
 [('r', 'rev', [], _("revision to fold")),
 ] + commitopts + commitopts2,
 _('hg split [OPTION]... [-r] REV'))
 def cmdsplit(ui, repo, *revs, **opts):
-"""Split the current commit using interactive selection
+"""split a changeset into smaller changesets
-By default, split the current revision by prompting for all its hunk to be
+By default, split the current revision by prompting for all its hunks to be
 redistributed into new changesets.
-Use --rev for splitting a given changeset instead.
+Use --rev to split a given changeset instead.
 """
 tr = wlock = lock = None
 newcommits = []
 revopt = opts.get('rev')

changeset 1575	0c8548df67fe
parent 1568	52c276d2ddb2
parent 1574	dcfe3afe548b
child 1576	526253198860