Help for RegistryOption confuses users
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Bazaar |
Confirmed
|
Medium
|
Unassigned |
Bug Description
> > Neither the output of "bzr help resolve" nor the manual bundled with
> > Bazaar 2.2.1 say anything about ARG in --action=ARG. Can someone
> > please tell what can it be and how it is used?
> >
> > TIA
>
> - From the help message:
>
> action:
> --action=ARG How to resolve the conflict.
> --done Marks the conflict as resolved
> --take-other Resolve the conflict taking the merged version into
> account
> --take-this Resolve the conflict preserving the version in the
> working tree
>
> ARG can be "done" "take-other" or "take-this".
Thanks.
Do you mean that --action=take-other is equivalent to --take-other, and
similarly for others? I suggest to spell that out in the text, as
it's not immediately evident.
Btw, I've got to reading this part because "What's New" has this
sentence where it describes the new --take-this and --take-other
options:
Just marking the conflict as resolved is still accessible via the
--done default action.
The "default action" part led me to look for non-default actions. The
problem is that the help text for "resolve" does not even mention the
word "action" except in the part shown above, and doesn't say that
"--done" is the default. Rather confusing.
The generated help should mention something like (--action=ARG or --ARG for short).
I.e:
action:
--action=ARG (or --ARG for short) How to resolve the conflict.
--done Marks the conflict as resolved
--take-other Resolve the conflict taking the merged version into
account
--take-this Resolve the conflict preserving the version in the
working tree