Patchwork D8808: fix: update documentation to reflect preference for --source over --rev

login
register
mail settings
Submitter phabricator
Date July 24, 2020, 3:39 p.m.
Message ID <differential-rev-PHID-DREV-xx37isxrfrgvkciv6uq2-req@mercurial-scm.org>
Download mbox | patch
Permalink /patch/46878/
State Superseded
Headers show

Comments

phabricator - July 24, 2020, 3:39 p.m.
martinvonz created this revision.
Herald added a reviewer: hg-reviewers.
Herald added a subscriber: mercurial-patches.

REVISION SUMMARY
  I should have updated the documentation in 5205b46bd887 <https://phab.mercurial-scm.org/rHG5205b46bd887f011e5732c04b644e102fca07897> (fix: add a -s
  option to format a revision and its descendants, 2020-03-13) and/or
  a6ef1e8e2f6d <https://phab.mercurial-scm.org/rHGa6ef1e8e2f6dedd3ec5ccbd151c0f09abeb34e54> (fix: mark -r as advanced, 2020-03-13)...

REPOSITORY
  rHG Mercurial

BRANCH
  default

REVISION DETAIL
  https://phab.mercurial-scm.org/D8808

AFFECTED FILES
  hgext/fix.py

CHANGE DETAILS




To: martinvonz, #hg-reviewers
Cc: mercurial-patches, mercurial-devel

Patch

diff --git a/hgext/fix.py b/hgext/fix.py
--- a/hgext/fix.py
+++ b/hgext/fix.py
@@ -241,15 +241,15 @@ 
     of files, unless the --whole flag is used. Some tools may always affect the
     whole file regardless of --whole.
 
-    If revisions are specified with --rev, those revisions will be checked, and
-    they may be replaced with new revisions that have fixed file content.  It is
-    desirable to specify all descendants of each specified revision, so that the
-    fixes propagate to the descendants. If all descendants are fixed at the same
-    time, no merging, rebasing, or evolution will be required.
+    If --working-dir is used, files with uncommitted changes in the working copy
+    will be fixed. Note that no backup are made.
 
-    If --working-dir is used, files with uncommitted changes in the working copy
-    will be fixed. If the checked-out revision is also fixed, the working
-    directory will update to the replacement revision.
+    If revisions are specified with --source, those revisions and their
+    descendants will be checked, and they may be replaced with new revisions
+    that have fixed file content. By automatically including the descendants,
+    no merging, rebasing, or evolution will be required. If an ancestor of the
+    working copy is included, then the working copy itself will also be fixed,
+    and the working copy will be updated to the fixed parent.
 
     When determining what lines of each file to fix at each revision, the whole
     set of revisions being fixed is considered, so that fixes to earlier