RFC: show the revision specifier on help

[Goffredo Baroncelli]

Hi all,

with the enclosed patch, the "bzr help -l" command shows info about the 
revision specifier. The info is get from the comment of the RevisionSpec 
subclass.

If you like the idea, I will update 
1) the help command in order to shows also the transport format/repository 
format
2) the bzr man page.

Open point:
- is it correct to integrate the revision specifier help in the "bzr 
help --long" command, or is it better to add another switch 
( -r|--revision) ?

Comments are welcome.

Goffredo

$ bzr help -l
bzr add [FILE...]
        Add specified files or directories.
[...]
bzr whoami [NAME]
        Show or set bzr user id.

Revision prefix specifier:
--------------------------
  revno:
    This takes the a number  and return the related revision.
    Optionally can be specified a branch
    examples:
      revno:1                   -> return the first revision
      revno:3:/path/to/branch   -> return the 3rd revision of
                                   the branch '/path/to/branch'
  revid:
    This takes the a revision-id and return the related revision.
    examples:
      revid:aaaa at bbbb-123456789
  last:
    This takes the a namber <n> and return the <n> - 1 revision before.
    examples:
      last:1        -> return the last revision
      last3:        -> return the last - 2 revision
  before:
    This takes the a revision and return the revision before.
    examples:
      before:1913
      before:revid:aaaa at bbbb-1234567890
  tag:
    To be implemented.
  date:
    This takes the date and return the first revision which matches.
    date can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
    matches the first entry after a given date (either at midnight or
    at a specified time).

    So the proper way of saying 'give me all entries for today' is:
          date:yesterday..date:today

    examples:
      date:yesterday
      date:2006-08-14,17:10:14
  ancestor:
    This takes the path to a branch and returns the common ancestor.
    examples:
      ancestor:/path/to/branch
  branch:
    This takes the path to a branch and returns its tip revision id.
    examples:
      branch:/path/to/branch


-- 
gpg key@ keyserver.linux.it: Goffredo Baroncelli (ghigo) <kreijack at inwind.it>
Key fingerprint = CE3C 7E01 6782 30A3 5B87  87C0 BB86 505C 6B2A CFF9
-------------- next part --------------
A non-text attachment was scrubbed...
Name: revisionspec-help.diff
Type: text/x-diff
Size: 3756 bytes
Desc: not available
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20060903/d6b8cad1/attachment.bin 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 191 bytes
Desc: not available
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20060903/d6b8cad1/attachment.pgp