Fix JavaDoc of AcceptsDelete

From the JavaDoc it is unclear what's the purpose of this interface. Its
class level JavaDoc says that it's to handle DELETE requests on the
RestCollection itself, but its apply method says it's for deleting a
member of the collection and hence for handling DELETE requests on a
member.

The truth is that this interface is used for two cases:

1. handling DELETE requests on the RestCollection (actually this
   functionaly seems to be unused, but RestApiServlet supports it)
2. handling DELETE requests on non-existing members of the
   RestCollection (in order to create that member)

Generally AcceptsDelete is not supported on root collections (because
support for it is not implemented in RestApiServlet).

Using this interface for two different purposes is a mess and creating
non-existing members of a collection by a DELETE request is strange (but
intended by change Ieeb15d0a91), but since I spent quite some time to
figure out how it works and what it is used for (change edits) I thought
I should at least write my findings into the JavaDoc.

Change-Id: Iaa9559cd775ee51c2b1066ede4107dd9978e4474
Signed-off-by: Edwin Kempin <ekempin@google.com>
1 file changed
tree: 6151593958f8d99e8f8330446c5e2e38628dc3ec
  1. .settings/
  2. antlr3/
  3. contrib/
  4. Documentation/
  5. gerrit-gwtdebug/
  6. gerrit-gwtui/
  7. gerrit-gwtui-common/
  8. gerrit-plugin-gwtui/
  9. java/
  10. javatests/
  11. lib/
  12. plugins/
  13. polygerrit-ui/
  14. prolog/
  15. prologtests/
  16. proto/
  17. resources/
  18. tools/
  19. webapp/
  20. .bazelproject
  21. .editorconfig
  22. .git-blame-ignore-revs
  23. .gitignore
  24. .gitmodules
  25. .mailmap
  26. .pydevproject
  27. 0001-Replace-native-http-git-_archive-with-Skylark-rules.patch
  28. 0002-Bump-Dagger-to-2.14.1-to-support-Java-9.patch
  29. BUILD
  30. COPYING
  31. INSTALL
  32. README.md
  33. SUBMITTING_PATCHES
  34. version.bzl
  35. WORKSPACE
README.md

Gerrit Code Review

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

Build Status

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 IRC channel on freenode is #gerrit. An archive is available at: echelog.com.

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 --recursive 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 7 based Gerrit image:

    docker run -p 8080:8080 gerritforge/gerrit-centos7[:version]

To run a Ubuntu 15.04 based Gerrit image:

    docker run -p 8080:8080 gerritforge/gerrit-ubuntu15.04[:version]

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