Please add help for common options, esp. -r

Bug #4662 reported by Jan Hudec
8
Affects Status Importance Assigned to Milestone
Bazaar
Confirmed
Low
Unassigned

Bug Description

Hello All,

I know I can find description of argument for -r on the wiki (http://bazaar.canonical.com/BzrRevisionSpec), but it would be nice if it could be part of built-in help. Especially since the options are defined globally, it should be possible to have:
{{{
$ bzr help options
...
--revision, -r REVISION Specify revision or revision range
...
}}}

And then
{{{
$ bzr help --revision
Specify revision or revision range
--revision, -r REVISION
REVISION can be ...
}}}
(or perhaps it would be {{{bzr help option revision}}} or {{{bzr help option --revision}}})

Regards,

Jan Hudec

Revision history for this message
John A Meinel (jameinel) wrote :

Many options do have extra help now.

If you want, go through and find where we are missing documentation, please do so.

Revision history for this message
Andrew Bennetts (spiv) wrote :

I can't find even a summary of the different "foo:" revision spec namespaces anywhere in my bzr help -- I'd expect at least a pointer to this information from e.g. "bzr log --help" and "bzr diff --help", which are the main places I want to use -r.

I don't mind if all the details of revision specs aren't in the help for log and diff, but there should at least be a URL telling me where I can learn more. Features like "bzr diff -r ancestor:../parent" are very useful, but totally unadvertised at the moment.

Revision history for this message
Robert Collins (lifeless) wrote :

this should 'just' need the -r option to have a docstring created for in bzrlib/option.py

Changed in bzr:
status: Unconfirmed → Confirmed
Revision history for this message
Olaf Conradi (olaf-conradi) wrote :

This bug is linked with https://launchpad.net/products/bzr/+bug/42714 in that bzr should have a way to create help options for things which arent commands. Like formats, and revision specs.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.