comparison tests/test-fix.t @ 45218:3ea3b85df03f

fix: update documentation to reflect preference for --source over --rev I should have updated the documentation in 5205b46bd887 (fix: add a -s option to format a revision and its descendants, 2020-03-13) and/or a6ef1e8e2f6d (fix: mark -r as advanced, 2020-03-13)... Differential Revision: https://phab.mercurial-scm.org/D8808
author Martin von Zweigbergk <martinvonz@google.com>
date Fri, 24 Jul 2020 08:38:19 -0700
parents a253ded5b03d
children f90a5c211251
comparison
equal deleted inserted replaced
45217:4e5da64d5549 45218:3ea3b85df03f
82 Runs any configured tools to fix the content of files. Only affects files 82 Runs any configured tools to fix the content of files. Only affects files
83 with changes, unless file arguments are provided. Only affects changed 83 with changes, unless file arguments are provided. Only affects changed
84 lines of files, unless the --whole flag is used. Some tools may always 84 lines of files, unless the --whole flag is used. Some tools may always
85 affect the whole file regardless of --whole. 85 affect the whole file regardless of --whole.
86 86
87 If revisions are specified with --rev, those revisions will be checked,
88 and they may be replaced with new revisions that have fixed file content.
89 It is desirable to specify all descendants of each specified revision, so
90 that the fixes propagate to the descendants. If all descendants are fixed
91 at the same time, no merging, rebasing, or evolution will be required.
92
93 If --working-dir is used, files with uncommitted changes in the working 87 If --working-dir is used, files with uncommitted changes in the working
94 copy will be fixed. If the checked-out revision is also fixed, the working 88 copy will be fixed. Note that no backup are made.
95 directory will update to the replacement revision. 89
90 If revisions are specified with --source, those revisions and their
91 descendants will be checked, and they may be replaced with new revisions
92 that have fixed file content. By automatically including the descendants,
93 no merging, rebasing, or evolution will be required. If an ancestor of the
94 working copy is included, then the working copy itself will also be fixed,
95 and the working copy will be updated to the fixed parent.
96 96
97 When determining what lines of each file to fix at each revision, the 97 When determining what lines of each file to fix at each revision, the
98 whole set of revisions being fixed is considered, so that fixes to earlier 98 whole set of revisions being fixed is considered, so that fixes to earlier
99 revisions are not forgotten in later ones. The --base flag can be used to 99 revisions are not forgotten in later ones. The --base flag can be used to
100 override this default behavior, though it is not usually desirable to do 100 override this default behavior, though it is not usually desirable to do