Revamp the documentation of the submit strategies

* Merge the 'Submit Type' section into the section that describes the
  'submit.action' configuration parameter.
* Make it clear that 'submit action', 'submit type' and also
  'submit strategy' are all synonymous terms.
* Add a hint explaining that the values to be set for submit.action in
  project.config indeed contain spaces (e.g. it's 'merge if necessary'
  and not 'merge_if_necessary').
* Keep existing anchors so that they continue working.
* Fix name of the 'Merge Always' submit action, which was wrongly
  documented as 'Always Merge'.
* Explicitly mention that 'cherry pick' is the only action that ignores
  dependencies.
* Order the submit actions by importance, starting with the most used
  submit action 'merge if necessary' and ending with the least
  recommended submit actions 'fast-forward-only' and 'cherry-pick'.
* Fix various formatting issues.
* Consistently wrap lines after 80 characters.

This revamp is just a first step to rework this documentation and
further improvements by follow-up changes are necessary. E.g. the
descriptions of the different submit actions have not been updated yet
and are still suboptimal and inconsistent.

Signed-off-by: Edwin Kempin <ekempin@google.com>
Release-Notes: skip
Change-Id: I0dd66d71f3989308cba32330412e4f90052f7a86
1 file changed
tree: d6a46757b6a2ebdff01626fa9ac9fdcf24835200
  1. .settings/
  2. .ts-out/
  3. antlr3/
  4. contrib/
  5. Documentation/
  6. e2e-tests/
  7. java/
  8. javatests/
  9. lib/
  10. modules/
  11. plugins/
  12. polygerrit-ui/
  13. prolog/
  14. prologtests/
  15. proto/
  16. resources/
  17. tools/
  18. webapp/
  19. .bazelignore
  20. .bazelproject
  21. .bazelrc
  22. .bazelversion
  23. .editorconfig
  24. .git-blame-ignore-revs
  25. .gitignore
  26. .gitmodules
  27. .gitreview
  28. .mailmap
  29. .pydevproject
  30. .zuul.yaml
  31. BUILD
  32. COPYING
  33. INSTALL
  34. Jenkinsfile
  35. package.json
  36. README.md
  37. SUBMITTING_PATCHES
  38. version.bzl
  39. WORKSPACE
  40. yarn.lock
README.md

Gerrit Code Review

Gerrit is a code review and project management tool for Git based projects.

Build Status Maven Central

Objective

Gerrit makes reviews easier by showing changes in a side-by-side display, and allowing inline comments to be added by any reviewer.

Gerrit simplifies Git based project maintainership by permitting any authorized user to submit changes to the master Git repository, rather than requiring all approved changes to be merged in by hand by the project maintainer.

Documentation

For information about how to install and use Gerrit, refer to the documentation.

Source

Our canonical Git repository is located on googlesource.com. There is a mirror of the repository on Github.

Reporting bugs

Please report bugs on the issue tracker.

Contribute

Gerrit is the work of hundreds of contributors. We appreciate your help!

Please read the contribution guidelines.

Note that we do not accept Pull Requests via the Github mirror.

Getting in contact

The Developer Mailing list is repo-discuss on Google Groups.

License

Gerrit is provided under the Apache License 2.0.

Build

Install Bazel and run the following:

    git clone --recurse-submodules https://gerrit.googlesource.com/gerrit
    cd gerrit && bazel build release

Install binary packages (Deb/Rpm)

The instruction how to configure GerritForge/BinTray repositories is here

On Debian/Ubuntu run:

    apt-get update && apt-get install gerrit=<version>-<release>

NOTE: release is a counter that starts with 1 and indicates the number of packages that have been released with the same version of the software.

On CentOS/RedHat run:

    yum clean all && yum install gerrit-<version>[-<release>]

On Fedora run:

    dnf clean all && dnf install gerrit-<version>[-<release>]

Use pre-built Gerrit images on Docker

Docker images of Gerrit are available on DockerHub

To run a CentOS 8 based Gerrit image:

    docker run -p 8080:8080 gerritcodereview/gerrit[:version]-centos8

To run a Ubuntu 20.04 based Gerrit image:

    docker run -p 8080:8080 gerritcodereview/gerrit[:version]-ubuntu20

NOTE: release is optional. Last released package of the version is installed if the release number is omitted.