This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9562

diff: describe behavior by using --from/--to instead of varying revision count
ClosedPublic

Authored by martinvonz on Dec 10 2020, 5:59 PM.

Details

Reviewers
mharbison72
Group Reviewers
hg-reviewers
Commits
rHGed5a0b5d21a6: diff: describe behavior by using --from/--to instead of varying revision count
Summary

I very recently updated the documentation to prefer --from/--to
over -r, but I missed the plain-text description of how the command
behaves when given different numbers of revisions (I guess I just
scanned the text for "-r"). This patch fixes that.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Revision Contents
Changeset List

PathPackages
Mmercurial/commands.py (19 lines)
Mtests/test-help.t (14 lines)

Diff 24178

mercurial/commands.py

Differences between files are shown using the unified diff format. Differences between files are shown using the unified diff format.
.. note:: .. note::
:hg:`diff` may generate unexpected results for merges, as it will :hg:`diff` may generate unexpected results for merges, as it will
default to comparing against the working directory's first default to comparing against the working directory's first
parent changeset if no revisions are specified. parent changeset if no revisions are specified.
When two revision arguments are given, then changes are shown By default, the working directory files are compared to its first parent. To
between those revisions. If only one revision is specified then see the differences from another revision, use --from. To see the difference
that revision is compared to the working directory, and, when no to another revision, use --to. For example, :hg:`diff --from .^` will show
revisions are specified, the working directory files are compared the differences from the working copy's grandparent to the working copy,
to its first parent. :hg:`diff --to .` will show the diff from the working copy to its parent
(i.e. the reverse of the default), and :hg:`diff --from 1.0 --to 1.2` will
Alternatively you can specify -c/--change with a revision to see show the diff between those two revisions.
the changes in that changeset relative to its first parent.
Alternatively you can specify -c/--change with a revision to see the changes
in that changeset relative to its first parent (i.e. :hg:`diff -c 42` is
equivalent to :hg:`diff --from 42^ --to 42`)
Without the -a/--text option, diff will avoid generating diffs of Without the -a/--text option, diff will avoid generating diffs of
files it detects as binary. With -a, diff will generate a diff files it detects as binary. With -a, diff will generate a diff
anyway, probably with undesirable results. anyway, probably with undesirable results.
Use the -g/--git option to generate diffs in the git extended diff Use the -g/--git option to generate diffs in the git extended diff
format. For more information, read :hg:`help diffs`. format. For more information, read :hg:`help diffs`.

tests/test-help.t

Differences between files are shown using the unified diff format. Differences between files are shown using the unified diff format.
Note: Note:
'hg diff' may generate unexpected results for merges, as it will 'hg diff' may generate unexpected results for merges, as it will
default to comparing against the working directory's first parent default to comparing against the working directory's first parent
changeset if no revisions are specified. changeset if no revisions are specified.
When two revision arguments are given, then changes are shown between By default, the working directory files are compared to its first parent.
those revisions. If only one revision is specified then that revision is To see the differences from another revision, use --from. To see the
compared to the working directory, and, when no revisions are specified, difference to another revision, use --to. For example, 'hg diff --from .^'
the working directory files are compared to its first parent. will show the differences from the working copy's grandparent to the
working copy, 'hg diff --to .' will show the diff from the working copy to
its parent (i.e. the reverse of the default), and 'hg diff --from 1.0 --to
1.2' will show the diff between those two revisions.
Alternatively you can specify -c/--change with a revision to see the Alternatively you can specify -c/--change with a revision to see the
changes in that changeset relative to its first parent. changes in that changeset relative to its first parent (i.e. 'hg diff -c
42' is equivalent to 'hg diff --from 42^ --to 42')
Without the -a/--text option, diff will avoid generating diffs of files it Without the -a/--text option, diff will avoid generating diffs of files it
detects as binary. With -a, diff will generate a diff anyway, probably detects as binary. With -a, diff will generate a diff anyway, probably
with undesirable results. with undesirable results.
Use the -g/--git option to generate diffs in the git extended diff format. Use the -g/--git option to generate diffs in the git extended diff format.
For more information, read 'hg help diffs'. For more information, read 'hg help diffs'.