Commits

Pierre-Yves David committed d48aae1

prune: documentation update

  • Participants
  • Parent commits f2c3fd2

Comments (0)

Files changed (2)

 
 3.0.0 -- 2013-02-02
 
+- prune: various minor improvements
+
+3.0.0 -- 2013-02-02
+
 - compatibility with 2.5
 
 2.2.0 --
      ('r', 'rev', [], _("revisions to prune"))],
     _('[OPTION] [-r] REV...'))
 def cmdprune(ui, repo, *revs, **opts):
-    """mark a changeset as obsolete
+    """get rid of changesets by marking them obsolete
 
-    This update the parent directory to a not-killed parent if the current
-    working directory parent are killed.
+    Obsolete changesets becomes invisible to all commands.
 
-    XXX bookmark support
-    XXX handle merge
-    XXX check immutable first
+    Non-pruned descendant of pruned changesets becomes "unstable". Use the
+    :hg:`evolve` to handle such situation.
+
+    When the working directory parent is pruned the repository is updated to a
+    non obsolete parents.
+
+    you can use the ``--succ`` option to informs mercurial that a newer version
+    of the pruned changeset exists.
+
+    XXX this commands needs bookmarks support.
     """
     revs = list(revs)
     revs.extend(opts['rev'])