Organize the rbt post --help output.

Review Request #5463 — Created Feb. 12, 2014 and submitted

Information

RBTools
master
adf58fe...

Reviewers

rbt post has a lot of options, and it was hard to figure out which
options were intended to serve which purposes, unless you knew what you
were looking for.

This organizes all the options into groups. To do this, I've implemented
a custom OptionGroup class that just wraps optparse's OptionGroup.
Commands can use this to group instances of our Option class under a
name and optional description.

The options are divided into the following groups:

* Posting Options
* Review Board Server Options
* Repository Options
* Review Request Field Options
* Diff Generation Options
* Git Options
* Perforce Options
* Subversion Options

Checked the help output and saw all the nice new groups.


Description From Last Updated

Can we move this to be the first group listed?

daviddavid

We can probably remove "hgsubversion" from this list (or we should add git-svn and git-p4).

daviddavid

This should maybe also mention that it's useful with --diff-filename.

daviddavid

Can we go through and make all the argument descriptions start with a capital letter like this one does? I …

daviddavid

specifiesthe

daviddavid

Can we change this to say Perforce/Plastic specifically? SVN and ClearCase support "changesets" but it's different.

daviddavid

This should also be Perforce/Plastic specific. Perhaps we can even move these down into an SCM-specific section?

daviddavid

This should say that this argument is deprecated.

daviddavid
david
  1. 
      
  2. rbt post help output
    39
      Posting Options:
    Show all issues

    Can we move this to be the first group listed?

  3. rbt post help output
    64
                            (bzr/git/hg/hgsubversion only)
    Show all issues

    We can probably remove "hgsubversion" from this list (or we should add git-svn and git-p4).

  4. rbt post help output
    128
        --basedir=PATH      the absolute path in the repository the diff was
    129
                            generated in. Will override the detected path.
    Show all issues

    This should maybe also mention that it's useful with --diff-filename.

  5. rbt post help output
    111
                            Tracking branch from which your branch is derived
    Show all issues

    Can we go through and make all the argument descriptions start with a capital letter like this one does? I think it looks nice, and it makes it way less weird for descriptions that have multiple sentences.

    (Perods wouldn't hurt, too).

  6. rbt post help output
    28
                            For git, this specifiesthe origin url of the current
    Show all issues

    specifiesthe

  7. rbt post help output
    54
                            new diff (only available if your repository supports
    55
                            changesets)
    Show all issues

    Can we change this to say Perforce/Plastic specifically? SVN and ClearCase support "changesets" but it's different.

  8. rbt post help output
    56
        --diff-only         uploads a new diff, but does not update info from the
    57
                            changelist.
    Show all issues

    This should also be Perforce/Plastic specific. Perhaps we can even move these down into an SCM-specific section?

    1. Not with two groups, and I don't want to add a bunch for every combination. I think it's okay just saying Perforce/Plastic.

  9. rbt post help output
    133
                            generate the diff for review based on a local SVN
    134
                            changelist
    Show all issues

    This should say that this argument is deprecated.

  10. 
      
chipx86
david
  1. Ship It!

  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Loading...