RBTools Documentation 0.8 alpha 0 (dev) documentation

RBTools Documentation

RBTools is a set of command line tools for working with Review Board andRBCommons. It’s there to help quickly get your code up for review, check onthe status of changes, and eventually land your code in the codebase,amongst other uses.

RBTools interfaces with your repository’s official command line tools, makingit easy to generate suitable diffs or to apply changes across any supportedtype of repository without having to learn different sets of tools.

Along with a variety of helpful commands, RBTools also provides a powerfulPython client API for Review Board, giving you the flexibility to develop yourown integrations.

What’s in RBTools

rbt Command

All the RBTools commands are invoked through the rbt tool. Thisruns on Windows, Linux, and MacOS X, and contains a number of usefulsub-commands through the following usage:

$ rbt <command> [options] [<args>]

You can get help on rbt or a sub-command in the following ways:

$ rbt help
$ rbt help <command>
$ rbt <command> --help

Some of the most commonly-used commands include:

• post - Posts changes to Review Board
• diff - Displays the diff that will be sent to Review Board
• land - Lands a change in a local branch or on a review request
• patch - Patches your tree with a change on a review request
• setup-repo - Sets up RBTools to talk to your repository

There are many other commands you may find useful. See thefull list of commands.

Python API

RBTools provides a Python module makes it easy to communicate with any ReviewBoard server using its powerful REST API. You can write custom scripts or evennew RBTools command that can attach metadata to review requests, performreviews, analyze diffs, extract analytics data, or almost anything else.

There’s a lot you can do with the API. See the RBTools Python APIdocumentation for more information.

Installation

To install RBTools, simply visit the RBTools Downloads page and follow theinstructions for your operating system. If you are using MacOS X or Windows,just run the installer and you’ll be set.

If you’re using Microsoft’s Team Foundation Server, there’s some extrainstallation or configuration that may be necessary.

Configuration

Once you’ve installed RBTools, you’ll want to configure it towork with your repositories. This is the firststep to allow any of your developers to easily post changes using RBTools.

There’s also a number ofuser-configurable options as well, includingcustomizable defaults for parameters andcustom aliases for common operations or sets offlags. Auto-completions are also available and can be installed by using thecommand rbt setup-completion.

Indices, Glossary and Tables

• Glossary

转自：https://www.reviewboard.org/docs/rbtools/dev/

------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

RBTools Documentation 0.8 alpha 0 (dev) documentation

Configuration

• Repository Configuration
• Per-User Configuration
• Team Foundation Server Configuration

转自：https://www.reviewboard.org/docs/rbtools/dev/rbt/configuration/

------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

RBTools Downloads

• macOS
• Linux
• Windows
• Other

What's new in 0.7.10

The full list of changes is available in the release notes.

To keep up with the latest releases, sign up for the mailing list.

Older Releases

Older releases of RBTools can be downloaded from our archive.

Bleeding Edge (Git)

RBTools's source code is available on GitHub. You can clone it by typing the following on the command line:

git clone git://github.com/reviewboard/rbtools.git

For more information, including installation and contribution instructions, see the Code Base Documentation.

转自：https://www.reviewboard.org/downloads/rbtools/

------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Team Foundation Server Configuration

Depending on what version of Visual Studio (or other development environment)you’re using, there are different requirements for TFS. The table belowsummarizes the three different methods and the different features which areavailable under each.

Note that if you’re running VS2017, the only option available is the built-intf.exe method.

	VS2017 tf.exe	rb-tfs adaptor	Team Explorer Everywhere
OS support	Windows	All	All
Visual Studio versions	2017	2010, 2013, 2015	2010, 2013, 2015
Posting pending changes	Yes	Yes	Yes
Posting committed changes	No	Yes	No
Posting shelvesets	No	Yes	No

VS2017 tf.exe

Visual Studio 2017 includes a command-line tool, tf.exe, whichincludes enough support for RBTools to post pending changes to Review Board.Committed changes can be posted, but only through the web UI, and shelvesetsare not supported.

Due to changes in Microsoft’s data storage formats, if you’re using VS2017, theother options (the rb-tfs adaptor and Team Explorer Everywhere) will not work.

This method requires GNU diff but no other installation.

rb-tfs adaptor

When using Visual Studio 2010 through 2015, the Team Explorer Everywhere tools,or the TFS extensions for Eclipse, we provide a custom adaptor which supportsposting pending, committed, or shelved changes.

To install the rb-tfs adaptor, run:

$ rbt install tfs

Team Explorer Everywhere

If you have the Team Explorer Everywhere command-line tools installed,RBTools can use that for posting committed changes. In all cases where youmight use this, the rb-tfs adaptor adaptor is faster and supports more features.Team Explorer Everywhere works with Visual Studio 2010 through 2015.

转自：

https://www.reviewboard.org/docs/rbtools/dev/rbt/configuration/tfs/#rbtools-tfs