comparison hgext/fix.py @ 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 797ef6f8295e
children 04de8a1ec08f
comparison
equal deleted inserted replaced
45217:4e5da64d5549 45218:3ea3b85df03f
239 Runs any configured tools to fix the content of files. Only affects files 239 Runs any configured tools to fix the content of files. Only affects files
240 with changes, unless file arguments are provided. Only affects changed lines 240 with changes, unless file arguments are provided. Only affects changed lines
241 of files, unless the --whole flag is used. Some tools may always affect the 241 of files, unless the --whole flag is used. Some tools may always affect the
242 whole file regardless of --whole. 242 whole file regardless of --whole.
243 243
244 If revisions are specified with --rev, those revisions will be checked, and
245 they may be replaced with new revisions that have fixed file content. It is
246 desirable to specify all descendants of each specified revision, so that the
247 fixes propagate to the descendants. If all descendants are fixed at the same
248 time, no merging, rebasing, or evolution will be required.
249
250 If --working-dir is used, files with uncommitted changes in the working copy 244 If --working-dir is used, files with uncommitted changes in the working copy
251 will be fixed. If the checked-out revision is also fixed, the working 245 will be fixed. Note that no backup are made.
252 directory will update to the replacement revision. 246
247 If revisions are specified with --source, those revisions and their
248 descendants will be checked, and they may be replaced with new revisions
249 that have fixed file content. By automatically including the descendants,
250 no merging, rebasing, or evolution will be required. If an ancestor of the
251 working copy is included, then the working copy itself will also be fixed,
252 and the working copy will be updated to the fixed parent.
253 253
254 When determining what lines of each file to fix at each revision, the whole 254 When determining what lines of each file to fix at each revision, the whole
255 set of revisions being fixed is considered, so that fixes to earlier 255 set of revisions being fixed is considered, so that fixes to earlier
256 revisions are not forgotten in later ones. The --base flag can be used to 256 revisions are not forgotten in later ones. The --base flag can be used to
257 override this default behavior, though it is not usually desirable to do so. 257 override this default behavior, though it is not usually desirable to do so.