gertty/doc/source/index.rst
James E. Blair 9783079c45 Add documentation
Add some actual sphinx documentation.  This is basically the README
split up into sections.  Once this is actually published somewhere,
we can remove some of the content from the README and link to an
on-line reference instead.

Change-Id: I25e5ff842e94a5a05aa62c164952df93efc49e98
2016-01-16 10:09:22 -08:00

1.1 KiB

Gertty

Gertty is a console-based interface to the Gerrit Code Review system.

As compared to the web interface, the main advantages are:

  • Workflow -- the interface is designed to support a workflow similar to reading network news or mail. In particular, it is designed to deal with a large number of review requests across a large number of projects.
  • Offline Use -- Gertty syncs information about changes in subscribed projects to a local database and local git repos. All review operations are performed against that database and then synced back to Gerrit.
  • Speed -- user actions modify locally cached content and need not wait for server interaction.
  • Convenience -- because Gertty downloads all changes to local git repos, a single command instructs it to checkout a change into that repo for detailed examination or testing of larger changes.

Contents:

installation.rst configuration.rst usage.rst contributing.rst

Indices and tables

  • genindex
  • modindex
  • search