This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8808

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

Authored by martinvonz on Jul 24 2020, 11:39 AM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHG3ea3b85df03f: fix: update documentation to reflect preference for --source over --rev
Summary

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)...

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

martinvonz created this revision.Jul 24 2020, 11:39 AM
pulkit accepted this revision.Jul 25 2020, 5:25 AM
This revision is now accepted and ready to land.Jul 25 2020, 5:25 AM
pulkit added a comment.Jul 25 2020, 5:52 AM

Updated test-fix.t in flight.

Revision Contents
Changeset List

PathPackages
Mhgext/fix.py (16 lines)
Mtests/test-fix.t (16 lines)

Diff 22124

hgext/fix.py

def fix(ui, repo, *pats, **opts): def fix(ui, repo, *pats, **opts):
"""rewrite file content in changesets or working directory """rewrite file content in changesets or working directory
Runs any configured tools to fix the content of files. Only affects files Runs any configured tools to fix the content of files. Only affects files
with changes, unless file arguments are provided. Only affects changed lines with changes, unless file arguments are provided. Only affects changed lines
of files, unless the --whole flag is used. Some tools may always affect the of files, unless the --whole flag is used. Some tools may always affect the
whole file regardless of --whole. 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 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 will be fixed. Note that no backup are made.
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 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 set of revisions being fixed is considered, so that fixes to earlier
revisions are not forgotten in later ones. The --base flag can be used to revisions are not forgotten in later ones. The --base flag can be used to
override this default behavior, though it is not usually desirable to do so. override this default behavior, though it is not usually desirable to do so.
""" """
opts = pycompat.byteskwargs(opts) opts = pycompat.byteskwargs(opts)
cmdutil.check_at_most_one_arg(opts, b'all', b'source', b'rev') cmdutil.check_at_most_one_arg(opts, b'all', b'source', b'rev')

tests/test-fix.t

rewrite file content in changesets or working directory rewrite file content in changesets or working directory
Runs any configured tools to fix the content of files. Only affects files Runs any configured tools to fix the content of files. Only affects files
with changes, unless file arguments are provided. Only affects changed with changes, unless file arguments are provided. Only affects changed
lines of files, unless the --whole flag is used. Some tools may always lines of files, unless the --whole flag is used. Some tools may always
affect the whole file regardless of --whole. 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 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 copy will be fixed. Note that no backup are made.
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 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 whole set of revisions being fixed is considered, so that fixes to earlier
revisions are not forgotten in later ones. The --base flag can be used to revisions are not forgotten in later ones. The --base flag can be used to
override this default behavior, though it is not usually desirable to do override this default behavior, though it is not usually desirable to do
so. so.
(use 'hg help -e fix' to show help for the fix extension) (use 'hg help -e fix' to show help for the fix extension)