gerrit/Documentation/cmd-ban-commit.txt
Michael Ochmann b99feabd88 Fix formatting of example blocks
With the new stylesheet example blocks (delimited with ====) are
rendered as rather intrusive boxes with large padding in yellow
and grey.

This patch replaces the example blocks with simple code blocks
(delimited with ----) that better match the overall style of the
documentation.

Change-Id: Id95387cdb153332c2066e2d5e378697647dbca52
Signed-off-by: Michael Ochmann <michael.ochmann@sap.com>
2016-07-07 14:06:31 +02:00

58 lines
1.2 KiB
Plaintext

= gerrit ban-commit
== NAME
gerrit ban-commit - Bans a commit from a project's repository.
== SYNOPSIS
[verse]
--
_ssh_ -p <port> <host> _gerrit ban-commit_
[--reason <REASON>]
<PROJECT>
<COMMIT> ...
--
== DESCRIPTION
Marks a commit as banned for the specified repository. If a commit is
banned Gerrit rejects every push that includes this commit with
link:error-contains-banned-commit.html[contains banned commit ...].
[NOTE]
This command just marks the commit as banned, but it does not remove
the commit from the history of any central branch. This needs to be
done manually.
== ACCESS
Caller must be owner of the project or be a member of the privileged
'Administrators' group.
== SCRIPTING
This command is intended to be used in scripts.
== OPTIONS
<PROJECT>::
Required; name of the project for which the commit should be
banned.
<COMMIT>::
Required; commit(s) that should be banned.
--reason::
Reason for banning the commit.
== EXAMPLES
Ban commit `421919d015c062fd28901fe144a78a555d0b5984` from project
`myproject`:
----
$ ssh -p 29418 review.example.com gerrit ban-commit myproject \
421919d015c062fd28901fe144a78a555d0b5984
----
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------