blob: 9686230f21f3298d8094990b821e63d13f9aa2f2 [file] [log] [blame]
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08001= gerrit set-project
Deniz Türkoglu01c75892012-05-09 12:43:02 -07002
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08003== NAME
Deniz Türkoglu01c75892012-05-09 12:43:02 -07004gerrit set-project - Change a project's settings.
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 set-project_
Deniz Türkoglu01c75892012-05-09 12:43:02 -070010 [--description <DESC> | -d <DESC>]
Edwin Kempin73b26982012-07-16 13:53:22 +020011 [--submit-type <TYPE> | -t <TYPE>]
Shawn O. Pearce2462ccb2012-10-17 18:20:40 -070012 [--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 Zivkova1ec9412013-07-01 15:01:59 +020017 [--max-object-size-limit <N>]
Deniz Türkoglu01c75892012-05-09 12:43:02 -070018 <NAME>
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -080019--
Deniz Türkoglu01c75892012-05-09 12:43:02 -070020
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080021== DESCRIPTION
Deniz Türkoglu01c75892012-05-09 12:43:02 -070022Modifies a given project's settings. This command can be useful to
23batch change projects.
24
25The command is argument-safe, that is, if no argument is given the
26previous settings are kept intact.
27
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080028== ACCESS
Hugo Arès36cc6fc2017-04-11 20:59:34 -040029Caller must be an owner of the given project.
Deniz Türkoglu01c75892012-05-09 12:43:02 -070030
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080031== SCRIPTING
Deniz Türkoglu01c75892012-05-09 12:43:02 -070032This command is intended to be used in scripts.
33
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080034== OPTIONS
Deniz Türkoglu01c75892012-05-09 12:43:02 -070035<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+
44Description 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 Pursehousea80f0e22013-09-16 22:25:05 +090055* REBASE_IF_NECESSARY: rebase the commit when required.
Gert van Dijka4e49d02017-08-27 22:50:40 +020056* REBASE_ALWAYS: always rebase the commit including dependencies.
Deniz Türkoglu01c75892012-05-09 12:43:02 -070057* MERGE_ALWAYS: always create a merge commit.
58* CHERRY_PICK: always cherry-pick the commit.
59
60+
61For more details see
Changcheng Xiao21885982019-01-15 18:16:51 +010062link:config-project-config.html#submit-type[Submit Types].
Deniz Türkoglu01c75892012-05-09 12:43:02 -070063
Shawn O. Pearce2462ccb2012-10-17 18:20:40 -070064--content-merge::
Deniz Türkoglu01c75892012-05-09 12:43:02 -070065 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. Pearce2462ccb2012-10-17 18:20:40 -070071--contributor-agreements::
Deniz Türkoglu01c75892012-05-09 12:43:02 -070072 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. Pearce2462ccb2012-10-17 18:20:40 -070076--signed-off-by::
Deniz Türkoglu01c75892012-05-09 12:43:02 -070077 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. Pearce2462ccb2012-10-17 18:20:40 -070080--change-id::
Deniz Türkoglu01c75892012-05-09 12:43:02 -070081 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
91is granted, but all modification operations are disabled.
92* HIDDEN: the project is not visible for those who are not owners
93
Sasa Zivkova1ec9412013-07-01 15:01:59 +020094--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+
101Common unit suffixes of 'k', 'm', or 'g' are supported.
102
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -0800103== EXAMPLES
Deniz Türkoglu01c75892012-05-09 12:43:02 -0700104Change project `example` to be hidden, require change id, don't use content merge
105and use 'merge if necessary' as merge strategy:
106
Michael Ochmannb99feab2016-07-06 14:10:22 +0200107----
David Shevitzc47f2362018-09-27 10:55:35 -0700108$ 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 Ochmannb99feab2016-07-06 14:10:22 +0200110----
Deniz Türkoglu01c75892012-05-09 12:43:02 -0700111
112GERRIT
113------
Sasa Zivkova1ec9412013-07-01 15:01:59 +0200114Part of link:index.html[Gerrit Code Review]
Yuxuan 'fishy' Wang99cb68d2013-10-31 17:26:00 -0700115
116SEARCHBOX
117---------