Merge lp:~spiv/bzr/tweak-revert-help into lp:bzr

Proposed by Andrew Bennetts on 2010-12-08
Status: Merged
Approved by: Martin Packman on 2010-12-08
Approved revision: 5563
Merged at revision: 5565
Proposed branch: lp:~spiv/bzr/tweak-revert-help
Merge into: lp:bzr
Diff against target: 26 lines (+5/-4)
1 file modified
bzrlib/builtins.py (+5/-4)
To merge this branch: bzr merge lp:~spiv/bzr/tweak-revert-help
Reviewer Review Type Date Requested Status
Martin Packman (community) 2010-12-08 Approve on 2010-12-08
Review via email: mp+43036@code.launchpad.net

Commit Message

Tweak 'revert' help.

Description of the Change

Tweak 'revert' help based on IRC feedback: make clear the meanings of -2 & -1, use '-r' rather than '--revision' in example, update text for shelve being built in, and add 'merge' and 'shelve' to the see also list. Thanks to achiang and fullermd.

To post a comment you must log in.
Matthew Fuller (fullermd) wrote :

> + merge instead. For example, "merge . --r -2..-3" will remove the changes
                                             ^^
Extra dash.

I'd add a "(don't miss the period)" sort of admonition to it somewhere
too; your eye is SO good at skipping right over that little
irrelevancy...

Andrew Bennetts (spiv) wrote :

> Extra dash.

Well spotted. Fixed.

> I'd add a "(don't miss the period)" sort of admonition to it somewhere
> too; your eye is SO good at skipping right over that little
> irrelevancy...

Added one.

Thanks very much!

lp:~spiv/bzr/tweak-revert-help updated on 2010-12-08
5563. By Andrew Bennetts on 2010-12-08

Fix double dash, highlight the significant '.' param.

Martin Packman (gz) wrote :

Helps make things clearer without bloating too much.

review: Approve
Vincent Ladeuil (vila) wrote :

sent to pqm by email

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'bzrlib/builtins.py'
2--- bzrlib/builtins.py 2010-11-30 05:49:40 +0000
3+++ bzrlib/builtins.py 2010-12-08 11:15:08 +0000
4@@ -4208,9 +4208,10 @@
5 last committed revision is used.
6
7 To remove only some changes, without reverting to a prior version, use
8- merge instead. For example, "merge . --revision -2..-3" will remove the
9- changes introduced by -2, without affecting the changes introduced by -1.
10- Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
11+ merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
12+ will remove the changes introduced by the second last commit (-2), without
13+ affecting the changes introduced by the last commit (-1). To remove
14+ certain changes on a hunk-by-hunk basis, see the shelve command.
15
16 By default, any files that have been manually changed will be backed up
17 first. (Files changed only by merge are not backed up.) Backup files have
18@@ -4246,7 +4247,7 @@
19 target branches.
20 """
21
22- _see_also = ['cat', 'export']
23+ _see_also = ['cat', 'export', 'merge', 'shelve']
24 takes_options = [
25 'revision',
26 Option('no-backup', "Do not save backups of reverted files."),