break lock help is useless

[Elan Ruusamäe]

what' i'm supposed to use for "LOCATION"? the "example" does not give any "help":

glen@wintersunset eventum/po $ bzr push
Using saved push location: bzr+ssh://bazaar.launchpad.net/~glen666/eventum/po/
Unable to obtain lock held by <email address hidden> on taotie (process #26310), acquired 7 minutes, 23 seconds ago.
See "bzr help break-lock" for more.
bzr: ERROR: Could not acquire lock "(remote lock)":
glen@wintersunset eventum/po $ bzr help break-lock
Purpose: Break a dead lock on a repository, branch or working directory.
Usage: bzr break-lock [LOCATION]

Options:
  --usage Show usage message and options.
  -v, --verbose Display more information.
  -q, --quiet Only display errors and warnings.
  -h, --help Show help message.

Description:
  CAUTION: Locks should only be broken when you are sure that the process
  holding the lock has been stopped.

  You can get information on what locks are open via the 'bzr info' command.

Examples:
    bzr break-lock

glen@wintersunset eventum/po $ bzr break-lock <email address hidden>
glen@wintersunset eventum/po $ bzr break-lock 26310
glen@wintersunset eventum/po $ bzr break-lock '<email address hidden> on taotie'
glen@wintersunset eventum/po $ bzr break-lock '<email address hidden> on taotie (process #26310)'
glen@wintersunset eventum/po $

[Matt Nordhoff (mnordhoff)]

Location has the same meaning as in other commands.

In this case, <bzr+ssh://bazaar.launchpad.net/~glen666/eventum/po/>.

For example:

$ bzr help push | head -n 2
Purpose: Update a mirror of this branch.
Usage: bzr push [LOCATION]

$ bzr push
Using saved push location: bzr+ssh://bazaar.launchpad.net/~glen666/eventum/po/

Location.

[Matt Nordhoff (mnordhoff)]

In this case, you could also use `bzr break-lock :push` (see `bzr help location-aliases`).

I'm assuming here that breaking the lock is actually a good idea in whatever situation you've gotten into, but who knows.

[Elan Ruusamäe (glen666)]

never needed help for other commands, so don't know what they describe. ok seems LOCATON is the push url.

however this bug is RFE, that "bzr help <command>" does not actually "help"

[Elan Ruusamäe (glen666)]

i.e the current help shows useless examples:

```
Examples:
    bzr break-lock

```

but should likely do:
```
Examples:
    bzr break-lock :push
    bzr break-lock lp:USERID
    bzr break-lock bzr+ssh://bazaar.launchpad.net/~USERID/REPOSITORY/BRANCH/

```

[Matt Nordhoff (mnordhoff)]

The current list of examples is:

> Examples:
> bzr break-lock
> bzr break-lock bzr+ssh://example.com/bzr/foo
> bzr break-lock --conf ~/.bazaar

The full help message (except for the options) is at:

<https://bazaar.launchpad.net/~bzr-pqm/bzr/bzr.dev/view/6606/bzrlib/builtins.py#L5457>

The `bzr+ssh:` one was added in 2010; the `--conf` one later.

You appear to be using a quite old version of bzr (`bzr version` will give the number).

Granted the current message remains terse, but do you think changes still need to be made?

[Elan Ruusamäe (glen666)]

oh, in newer bzr indeed usage is better. i guess can close as WONTFIX or INVALID

➔ bzr help break-lock
Purpose: Break a dead lock.
Usage: bzr break-lock [LOCATION]

Options:
  --force Do not ask for confirmation before breaking the lock.
  -v, --verbose Display more information.
  -q, --quiet Only display errors and warnings.
  --usage Show usage message and options.
  --config LOCATION is the directory where the config lock is.
  -h, --help Show help message.

Description:
  This command breaks a lock on a repository, branch, working directory or
  config file.

  CAUTION: Locks should only be broken when you are sure that the process
  holding the lock has been stopped.

  You can get information on what locks are open via the 'bzr info
  [location]' command.

Examples:
    bzr break-lock
    bzr break-lock bzr+ssh://example.com/bzr/foo
    bzr break-lock --conf ~/.bazaar

➔ bzr --version
Bazaar (bzr) 2.6.0