opendev/gerrit
Code Issues Proposed changes

Improve documentation of commit validation

Browse Source 
Mention that the plugin can reject commits by throwing an
exception.

Make it clearer that the validation also applies to commits made
within the Gerrit Web UI.

Change-Id: Ibd58aed5cd2a25ebe882020c7a530942c18dd8cd
This commit is contained in:
David Pursehouse 2013-05-30 10:16:17 +09:00
parent 9d2ca21962
commit cde597d4f4
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Documentation/config-validation.txt
View File

@ -2,14 +2,18 @@ Gerrit Code Review - Commit Validation
======================================
Gerrit supports link:dev-plugins.html[plugin-based] validation of
uploaded commits.
commits.
This allows plugins to perform additional validation checks against
uploaded commits, and send back a warning or error message to the git
client.
Plugins implementing the `CommitValidationListener` interface can
perform additional validation checks against new commits.
To make use of this feature, a plugin must implement the `CommitValidationListener`
interface.
If the commit fails the validation, the plugin can either provide a
message that will be sent back to the git client, or throw an exception
which will cause the commit to be rejected.
Validation applies to both commits uploaded via `git push`, and new
commits generated via Gerrit's Web UI features such as the rebase, revert
and cherry-pick buttons.
Out of the box, Gerrit includes a plugin that checks the length of the
subject and body lines of commit messages on uploaded commits.