LinuxCommandLibrary

rbt

Manage Review Board code reviews

TLDR

Post changes to Review Board

$ rbt post [change_number]
copy

Display the diff that will be sent to Review Board
$ rbt diff
copy

Land a change in a local branch or on a review request
$ rbt land [branch_name]
copy

Patch your tree with a change on a review request
$ rbt patch [review_request_id]
copy

Set up RBTool to talk to a repository
$ rbt setup-repo
copy

SYNOPSIS

rbt command [options]

PARAMETERS

diff
    Uploads a diff to Review Board. Allows for specifying revision ranges, targets, and other diff options.

patch
    Applies a review from Review Board as a patch to the local codebase.

post
    Creates or updates a review request on Review Board.

status
    Displays the status of a review request.

login
    Stores credentials for authenticating to Review Board.

logout
    Removes stored credentials.

setup-repo
    Sets up a repository to work with Review Board and rbt.

--debug
    Enables debug output to aid in troubleshooting.

--version
    Displays the version of rbt.

DESCRIPTION

The rbt command is a command-line tool used for interacting with Review Board, a web-based code review tool. It simplifies the process of submitting code changes for review, updating review requests, and performing other common Review Board tasks from the command line. It is part of the `rbtools` package, a collection of scripts and utilities that integrate with Review Board. rbt reduces manual steps, automates formatting, and streamlines the review workflow. This improves developer productivity and ensures consistent review processes.

CAVEATS

Requires the `rbtools` package to be installed and properly configured to connect to a Review Board server. Ensure the Review Board server URL is correctly set up in the configuration files. The specific options available for each command can vary depending on the version of `rbtools`.

CONFIGURATION

rbt relies on configuration files (e.g., .reviewboardrc) to store server URLs, repository information, and user credentials. These files can be located in various locations, including the user's home directory or the project's root directory.
Review the rbtools documentation for detailed guidance on configuration.

WORKFLOW EXAMPLES

Typical usage involves creating a diff using `git diff`, then using `rbt post` to upload the diff to Review Board and create a new review request. Subsequent updates to the diff can be submitted using `rbt post -u` to update the existing review request. Reviewers can then use `rbt patch` to apply the changes locally for testing.

HISTORY

The rbt command and the `rbtools` package were developed to simplify the interaction between developers and Review Board. Before its existence, submitting code for review was a manual and often error-prone process. rbt automated many of these steps, significantly improving the efficiency of code reviews.

SEE ALSO

diff(1), patch(1)

Copied to clipboard