Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 1 | = gerrit set-project |
Deniz Türkoglu | 01c7589 | 2012-05-09 12:43:02 -0700 | [diff] [blame] | 2 | |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 3 | == NAME |
Deniz Türkoglu | 01c7589 | 2012-05-09 12:43:02 -0700 | [diff] [blame] | 4 | gerrit set-project - Change a project's settings. |
| 5 | |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 6 | == SYNOPSIS |
Michael Ochmann | e2d76a1 | 2016-06-23 17:07:37 +0200 | [diff] [blame] | 7 | [verse] |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 8 | -- |
Michael Ochmann | e2d76a1 | 2016-06-23 17:07:37 +0200 | [diff] [blame] | 9 | _ssh_ -p <port> <host> _gerrit set-project_ |
Deniz Türkoglu | 01c7589 | 2012-05-09 12:43:02 -0700 | [diff] [blame] | 10 | [--description <DESC> | -d <DESC>] |
Edwin Kempin | 73b2698 | 2012-07-16 13:53:22 +0200 | [diff] [blame] | 11 | [--submit-type <TYPE> | -t <TYPE>] |
Shawn O. Pearce | 2462ccb | 2012-10-17 18:20:40 -0700 | [diff] [blame] | 12 | [--contributor-agreements <true|false|inherit>] |
| 13 | [--signed-off-by <true|false|inherit>] |
| 14 | [--content-merge <true|false|inherit>] |
| 15 | [--change-id <true|false|inherit>] |
| 16 | [--project-state <STATE> | --ps <STATE>] |
Sasa Zivkov | a1ec941 | 2013-07-01 15:01:59 +0200 | [diff] [blame] | 17 | [--max-object-size-limit <N>] |
Deniz Türkoglu | 01c7589 | 2012-05-09 12:43:02 -0700 | [diff] [blame] | 18 | <NAME> |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 19 | -- |
Deniz Türkoglu | 01c7589 | 2012-05-09 12:43:02 -0700 | [diff] [blame] | 20 | |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 21 | == DESCRIPTION |
Deniz Türkoglu | 01c7589 | 2012-05-09 12:43:02 -0700 | [diff] [blame] | 22 | Modifies a given project's settings. This command can be useful to |
| 23 | batch change projects. |
| 24 | |
| 25 | The command is argument-safe, that is, if no argument is given the |
| 26 | previous settings are kept intact. |
| 27 | |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 28 | == ACCESS |
Hugo Arès | 36cc6fc | 2017-04-11 20:59:34 -0400 | [diff] [blame] | 29 | Caller must be an owner of the given project. |
Deniz Türkoglu | 01c7589 | 2012-05-09 12:43:02 -0700 | [diff] [blame] | 30 | |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 31 | == SCRIPTING |
Deniz Türkoglu | 01c7589 | 2012-05-09 12:43:02 -0700 | [diff] [blame] | 32 | This command is intended to be used in scripts. |
| 33 | |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 34 | == OPTIONS |
Deniz Türkoglu | 01c7589 | 2012-05-09 12:43:02 -0700 | [diff] [blame] | 35 | <NAME>:: |
| 36 | Required; name of the project to edit. If name ends |
| 37 | with `.git` the suffix will be automatically removed. |
| 38 | |
| 39 | --description:: |
| 40 | -d:: |
| 41 | New description of the project. If not specified, |
| 42 | the old description is kept. |
| 43 | + |
| 44 | Description values containing spaces should be quoted in single quotes |
| 45 | ('). This most likely requires double quoting the value, for example |
| 46 | `--description "'A description string'"`. |
| 47 | |
| 48 | --submit-type:: |
| 49 | -t:: |
| 50 | Action used by Gerrit to submit an approved change to its |
| 51 | destination branch. Supported options are: |
| 52 | + |
| 53 | * FAST_FORWARD_ONLY: produces a strictly linear history. |
| 54 | * MERGE_IF_NECESSARY: create a merge commit when required. |
David Pursehouse | a80f0e2 | 2013-09-16 22:25:05 +0900 | [diff] [blame] | 55 | * REBASE_IF_NECESSARY: rebase the commit when required. |
Gert van Dijk | a4e49d0 | 2017-08-27 22:50:40 +0200 | [diff] [blame] | 56 | * REBASE_ALWAYS: always rebase the commit including dependencies. |
Deniz Türkoglu | 01c7589 | 2012-05-09 12:43:02 -0700 | [diff] [blame] | 57 | * MERGE_ALWAYS: always create a merge commit. |
| 58 | * CHERRY_PICK: always cherry-pick the commit. |
| 59 | |
| 60 | + |
| 61 | For more details see |
Changcheng Xiao | 2188598 | 2019-01-15 18:16:51 +0100 | [diff] [blame] | 62 | link:config-project-config.html#submit-type[Submit Types]. |
Deniz Türkoglu | 01c7589 | 2012-05-09 12:43:02 -0700 | [diff] [blame] | 63 | |
Shawn O. Pearce | 2462ccb | 2012-10-17 18:20:40 -0700 | [diff] [blame] | 64 | --content-merge:: |
Deniz Türkoglu | 01c7589 | 2012-05-09 12:43:02 -0700 | [diff] [blame] | 65 | If enabled, Gerrit will try to perform a 3-way merge of text |
| 66 | file content when a file has been modified by both the |
| 67 | destination branch and the change being submitted. This |
| 68 | option only takes effect if submit type is not |
| 69 | FAST_FORWARD_ONLY. |
| 70 | |
Shawn O. Pearce | 2462ccb | 2012-10-17 18:20:40 -0700 | [diff] [blame] | 71 | --contributor-agreements:: |
Deniz Türkoglu | 01c7589 | 2012-05-09 12:43:02 -0700 | [diff] [blame] | 72 | If enabled, authors must complete a contributor agreement |
| 73 | on the site before pushing any commits or changes to this |
| 74 | project. |
| 75 | |
Shawn O. Pearce | 2462ccb | 2012-10-17 18:20:40 -0700 | [diff] [blame] | 76 | --signed-off-by:: |
Deniz Türkoglu | 01c7589 | 2012-05-09 12:43:02 -0700 | [diff] [blame] | 77 | If enabled, each change must contain a Signed-off-by line |
| 78 | from either the author or the uploader in the commit message. |
| 79 | |
Shawn O. Pearce | 2462ccb | 2012-10-17 18:20:40 -0700 | [diff] [blame] | 80 | --change-id:: |
Deniz Türkoglu | 01c7589 | 2012-05-09 12:43:02 -0700 | [diff] [blame] | 81 | Require a valid link:user-changeid.html[Change-Id] footer |
| 82 | in any commit uploaded for review. This does not apply to |
| 83 | commits pushed directly to a branch or tag. |
| 84 | |
| 85 | --project-state:: |
| 86 | --ps:: |
| 87 | Set project's visibility. |
| 88 | + |
| 89 | * ACTIVE: project is regular and is the default value. |
| 90 | * READ_ONLY: users can see the project if read permission |
| 91 | is granted, but all modification operations are disabled. |
| 92 | * HIDDEN: the project is not visible for those who are not owners |
| 93 | |
Sasa Zivkov | a1ec941 | 2013-07-01 15:01:59 +0200 | [diff] [blame] | 94 | --max-object-size-limit:: |
| 95 | Define maximum Git object size for this project. Pushes containing an |
| 96 | object larger than this limit will be rejected. This can be used to |
| 97 | further limit the global |
| 98 | link:config-gerrit.html#receive.maxObjectSizeLimit[receive.maxObjectSizeLimit] |
| 99 | and cannot be used to increase that globally set limit. |
| 100 | + |
| 101 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
| 102 | |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 103 | == EXAMPLES |
Deniz Türkoglu | 01c7589 | 2012-05-09 12:43:02 -0700 | [diff] [blame] | 104 | Change project `example` to be hidden, require change id, don't use content merge |
| 105 | and use 'merge if necessary' as merge strategy: |
| 106 | |
Michael Ochmann | b99feab | 2016-07-06 14:10:22 +0200 | [diff] [blame] | 107 | ---- |
David Shevitz | c47f236 | 2018-09-27 10:55:35 -0700 | [diff] [blame] | 108 | $ ssh -p 29418 review.example.com gerrit set-project example --submit-type MERGE_IF_NECESSARY \ |
| 109 | --change-id true --content-merge false --project-state HIDDEN |
Michael Ochmann | b99feab | 2016-07-06 14:10:22 +0200 | [diff] [blame] | 110 | ---- |
Deniz Türkoglu | 01c7589 | 2012-05-09 12:43:02 -0700 | [diff] [blame] | 111 | |
| 112 | GERRIT |
| 113 | ------ |
Sasa Zivkov | a1ec941 | 2013-07-01 15:01:59 +0200 | [diff] [blame] | 114 | Part of link:index.html[Gerrit Code Review] |
Yuxuan 'fishy' Wang | 99cb68d | 2013-10-31 17:26:00 -0700 | [diff] [blame] | 115 | |
| 116 | SEARCHBOX |
| 117 | --------- |