blob: 80f41f041cb251e05a1c62dda62344d524075782 [file] [log] [blame]
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08001= gerrit ban-commit
Edwin Kempinf485a0d2012-03-30 08:11:47 +02002
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08003== NAME
Edwin Kempinf485a0d2012-03-30 08:11:47 +02004gerrit ban-commit - Bans a commit from a project's repository.
5
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08006== SYNOPSIS
Michael Ochmanne2d76a12016-06-23 17:07:37 +02007[verse]
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -08008--
Michael Ochmanne2d76a12016-06-23 17:07:37 +02009_ssh_ -p <port> <host> _gerrit ban-commit_
Edwin Kempinf485a0d2012-03-30 08:11:47 +020010 [--reason <REASON>]
11 <PROJECT>
12 <COMMIT> ...
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -080013--
Edwin Kempinf485a0d2012-03-30 08:11:47 +020014
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080015== DESCRIPTION
Edwin Kempinf485a0d2012-03-30 08:11:47 +020016Marks a commit as banned for the specified repository. If a commit is
17banned Gerrit rejects every push that includes this commit with
18link:error-contains-banned-commit.html[contains banned commit ...].
19
20[NOTE]
21This command just marks the commit as banned, but it does not remove
22the commit from the history of any central branch. This needs to be
23done manually.
24
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080025== ACCESS
Edwin Kempinf485a0d2012-03-30 08:11:47 +020026Caller must be owner of the project or be a member of the privileged
27'Administrators' group.
28
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080029== SCRIPTING
Edwin Kempinf485a0d2012-03-30 08:11:47 +020030This command is intended to be used in scripts.
31
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080032== OPTIONS
Edwin Kempinf485a0d2012-03-30 08:11:47 +020033<PROJECT>::
34 Required; name of the project for which the commit should be
35 banned.
36
37<COMMIT>::
38 Required; commit(s) that should be banned.
39
40--reason::
41 Reason for banning the commit.
42
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080043== EXAMPLES
Edwin Kempinf485a0d2012-03-30 08:11:47 +020044Ban commit `421919d015c062fd28901fe144a78a555d0b5984` from project
45`myproject`:
46
Michael Ochmannb99feab2016-07-06 14:10:22 +020047----
Edwin Kempinf485a0d2012-03-30 08:11:47 +020048 $ ssh -p 29418 review.example.com gerrit ban-commit myproject \
49 421919d015c062fd28901fe144a78a555d0b5984
Michael Ochmannb99feab2016-07-06 14:10:22 +020050----
Edwin Kempinf485a0d2012-03-30 08:11:47 +020051
52GERRIT
53------
54Part of link:index.html[Gerrit Code Review]
Yuxuan 'fishy' Wang99cb68d2013-10-31 17:26:00 -070055
56SEARCHBOX
57---------