Make all external links in the documentation open in a new window
To make it easier to stay on track when reading documentation, I added ",role=external,window=_blank" to all links in the documentation directory that were not pointing at another piece of documentation. Change-Id: I94bf254c90f8ebce067c765be0a2932b755a045a
This commit is contained in:
parent
73b226647f
commit
34253376e6
@ -7,10 +7,10 @@ users.
|
|||||||
|
|
||||||
To view/edit the access controls for a specific project, first
|
To view/edit the access controls for a specific project, first
|
||||||
navigate to the projects page: for example,
|
navigate to the projects page: for example,
|
||||||
https://gerrit-review.googlesource.com/admin/repos/ . Then click on
|
https://gerrit-review.googlesource.com/admin/repos/[role=external,window=_blank]. Then click on
|
||||||
the individual project, and then click Access. This will bring you
|
the individual project, and then click Access. This will bring you
|
||||||
to a url that looks like
|
to a url that looks like
|
||||||
https://gerrit-review.googlesource.com/admin/repos/gerrit,access
|
https://gerrit-review.googlesource.com/admin/repos/gerrit,access[role=external,window=_blank]
|
||||||
|
|
||||||
[[system_groups]]
|
[[system_groups]]
|
||||||
== System Groups
|
== System Groups
|
||||||
@ -218,7 +218,7 @@ by prefixing the reference name with `^`. For example
|
|||||||
`^refs/heads/[a-z]{1,8}` matches all lower case branch names
|
`^refs/heads/[a-z]{1,8}` matches all lower case branch names
|
||||||
between 1 and 8 characters long. Within a regular expression `.`
|
between 1 and 8 characters long. Within a regular expression `.`
|
||||||
is a wildcard matching any character, but may be escaped as `\.`.
|
is a wildcard matching any character, but may be escaped as `\.`.
|
||||||
The link:http://www.brics.dk/automaton/[dk.brics.automaton library]
|
The link:http://www.brics.dk/automaton/[dk.brics.automaton library,role=external,window=_blank]
|
||||||
is used for evaluation of regular expression access control
|
is used for evaluation of regular expression access control
|
||||||
rules. See the library documentation for details on this
|
rules. See the library documentation for details on this
|
||||||
particular regular expression flavor. One quirk is that the
|
particular regular expression flavor. One quirk is that the
|
||||||
@ -979,7 +979,7 @@ A typical Continuous Integration system should be able to download new changes
|
|||||||
to build and then leave a verdict somehow.
|
to build and then leave a verdict somehow.
|
||||||
|
|
||||||
As an example, the popular
|
As an example, the popular
|
||||||
link:https://wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger[gerrit-trigger plugin]
|
link:https://wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger[gerrit-trigger plugin,role=external,window=_blank]
|
||||||
for Jenkins/Hudson can set labels at:
|
for Jenkins/Hudson can set labels at:
|
||||||
|
|
||||||
* The start of a build
|
* The start of a build
|
||||||
|
@ -47,7 +47,7 @@ for production installations.
|
|||||||
+
|
+
|
||||||
If you have chosen to use _Elastic Search_ for indexing,
|
If you have chosen to use _Elastic Search_ for indexing,
|
||||||
refer to its
|
refer to its
|
||||||
link:https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[backup documentation].
|
link:https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[backup documentation,role=external,window=_blank].
|
||||||
|
|
||||||
[#optional-backup-cache]
|
[#optional-backup-cache]
|
||||||
Caches::
|
Caches::
|
||||||
@ -70,7 +70,7 @@ directory also contains secrets which should be handled separately
|
|||||||
* public and private SSH host keys
|
* public and private SSH host keys
|
||||||
+
|
+
|
||||||
You may consider to use the
|
You may consider to use the
|
||||||
link:https://gerrit.googlesource.com/plugins/secure-config/[secure-config plugin]
|
link:https://gerrit.googlesource.com/plugins/secure-config/[secure-config plugin,role=external,window=_blank]
|
||||||
to encrypt these secrets.
|
to encrypt these secrets.
|
||||||
|
|
||||||
[#optional-backup-plugin-data]
|
[#optional-backup-plugin-data]
|
||||||
@ -144,7 +144,7 @@ server is read-only or down as short as possible.
|
|||||||
Make the server read-only before taking the backup. This means read-access
|
Make the server read-only before taking the backup. This means read-access
|
||||||
is still available during backup, because only write operations have to be
|
is still available during backup, because only write operations have to be
|
||||||
stopped to ensure consistency. This can be implemented using the
|
stopped to ensure consistency. This can be implemented using the
|
||||||
link:https://gerrit.googlesource.com/plugins/readonly/[_readonly_] plugin.
|
link:https://gerrit.googlesource.com/plugins/readonly/[_readonly_,role=external,window=_blank] plugin.
|
||||||
|
|
||||||
[#cons-backup-replicate]
|
[#cons-backup-replicate]
|
||||||
=== Replicate data for backup
|
=== Replicate data for backup
|
||||||
@ -156,9 +156,9 @@ file, ref-logs, git configs, and alternate configs.
|
|||||||
Replicate all git repositories to another file system using
|
Replicate all git repositories to another file system using
|
||||||
`git clone --mirror`,
|
`git clone --mirror`,
|
||||||
or the
|
or the
|
||||||
link:https://gerrit.googlesource.com/plugins/replication[replication plugin]
|
link:https://gerrit.googlesource.com/plugins/replication[replication plugin,role=external,window=_blank]
|
||||||
or the
|
or the
|
||||||
link:https://gerrit.googlesource.com/plugins/pull-replication[pull-replication plugin].
|
link:https://gerrit.googlesource.com/plugins/pull-replication[pull-replication plugin,role=external,window=_blank].
|
||||||
Best you use a filesystem supporting snapshots to create a backup archive
|
Best you use a filesystem supporting snapshots to create a backup archive
|
||||||
of such a replica.
|
of such a replica.
|
||||||
|
|
||||||
@ -173,7 +173,7 @@ with the backup of the git repositories.
|
|||||||
Do not skip backing up the replica, the replica alone IS NOT a backup.
|
Do not skip backing up the replica, the replica alone IS NOT a backup.
|
||||||
Imagine someone deleted a project by mistake and this deletion got replicated.
|
Imagine someone deleted a project by mistake and this deletion got replicated.
|
||||||
Replication of repository deletions can be switched off using the
|
Replication of repository deletions can be switched off using the
|
||||||
link:https://gerrit.googlesource.com/plugins/replication/+/refs/heads/master/src/main/resources/Documentation/config.md[server option]
|
link:https://gerrit.googlesource.com/plugins/replication/+/refs/heads/master/src/main/resources/Documentation/config.md[server option,role=external,window=_blank]
|
||||||
`remote.NAME.replicateProjectDeletions`.
|
`remote.NAME.replicateProjectDeletions`.
|
||||||
|
|
||||||
If you are using Gerrit replica to offload read traffic you can use one of these
|
If you are using Gerrit replica to offload read traffic you can use one of these
|
||||||
@ -195,13 +195,13 @@ repositories) which affect the repositories may need to be shut down.
|
|||||||
Filesystems supporting copy on write snapshots::
|
Filesystems supporting copy on write snapshots::
|
||||||
+
|
+
|
||||||
Use a file system supporting copy-on-write snapshots like
|
Use a file system supporting copy-on-write snapshots like
|
||||||
link:https://btrfs.wiki.kernel.org/index.php/SysadminGuide#Snapshots[btrfs]
|
link:https://btrfs.wiki.kernel.org/index.php/SysadminGuide#Snapshots[btrfs,role=external,window=_blank]
|
||||||
or
|
or
|
||||||
https://wiki.debian.org/ZFS#Snapshots[zfs].
|
https://wiki.debian.org/ZFS#Snapshots[zfs,role=external,window=_blank].
|
||||||
|
|
||||||
|
|
||||||
Other filesystems supporting snapshots::
|
Other filesystems supporting snapshots::
|
||||||
https://wiki.archlinux.org/index.php/LVM#Snapshots[lvm] or nfs.
|
https://wiki.archlinux.org/index.php/LVM#Snapshots[lvm,role=external,window=_blank] or nfs.
|
||||||
+
|
+
|
||||||
Create a snapshot and then archive the snapshot to another storage.
|
Create a snapshot and then archive the snapshot to another storage.
|
||||||
+
|
+
|
||||||
@ -257,7 +257,7 @@ And fire drill restoring a new site using the backup.
|
|||||||
[#backup-dr-multi-site]
|
[#backup-dr-multi-site]
|
||||||
=== Multi-site setup
|
=== Multi-site setup
|
||||||
|
|
||||||
Use the https://gerrit.googlesource.com/plugins/multi-site[multi-site plugin]
|
Use the https://gerrit.googlesource.com/plugins/multi-site[multi-site plugin,role=external,window=_blank]
|
||||||
to install Gerrit with multiple sites installed in different datacenters
|
to install Gerrit with multiple sites installed in different datacenters
|
||||||
across different regions. This ensures that in case of a severe problem with
|
across different regions. This ensures that in case of a severe problem with
|
||||||
one of the sites, the other sites can still serve your repositories.
|
one of the sites, the other sites can still serve your repositories.
|
||||||
|
@ -86,8 +86,8 @@ $ chmod u+x ~/duhproject/.git/hooks/commit-msg
|
|||||||
|
|
||||||
|
|
||||||
* link:user-changeid.html[Change-Id Lines]
|
* link:user-changeid.html[Change-Id Lines]
|
||||||
* link:http://www.kernel.org/pub/software/scm/git/docs/git-commit.html[git-commit(1)]
|
* link:http://www.kernel.org/pub/software/scm/git/docs/git-commit.html[git-commit(1),role=external,window=_blank]
|
||||||
* link:http://www.kernel.org/pub/software/scm/git/docs/githooks.html[githooks(5)]
|
* link:http://www.kernel.org/pub/software/scm/git/docs/githooks.html[githooks(5),role=external,window=_blank]
|
||||||
|
|
||||||
== IMPLEMENTATION
|
== IMPLEMENTATION
|
||||||
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
= The refs/for namespace
|
= The refs/for namespace
|
||||||
|
|
||||||
When pushing a new or updated commit to Gerrit, you push that commit using a
|
When pushing a new or updated commit to Gerrit, you push that commit using a
|
||||||
link:https://www.kernel.org/pub/software/scm/git/docs/gitglossary.html#def_ref[reference],
|
link:https://www.kernel.org/pub/software/scm/git/docs/gitglossary.html#def_ref[reference,role=external,window=_blank],
|
||||||
in the `refs/for` namespace. This reference must also define
|
in the `refs/for` namespace. This reference must also define
|
||||||
the target branch, such as `refs/for/[BRANCH_NAME]`.
|
the target branch, such as `refs/for/[BRANCH_NAME]`.
|
||||||
|
|
||||||
|
@ -143,7 +143,7 @@ Stores the link:#project-watches[project watches] of the account.
|
|||||||
|
|
||||||
In addition it contains an
|
In addition it contains an
|
||||||
link:https://en.wikibooks.org/wiki/OpenSSH/Client_Configuration_Files#.7E.2F.ssh.2Fauthorized_keys[
|
link:https://en.wikibooks.org/wiki/OpenSSH/Client_Configuration_Files#.7E.2F.ssh.2Fauthorized_keys[
|
||||||
authorized_keys] file with the link:#ssh-keys[SSH keys] of the account.
|
authorized_keys,role=external,window=_blank] file with the link:#ssh-keys[SSH keys] of the account.
|
||||||
|
|
||||||
[[account-properties]]
|
[[account-properties]]
|
||||||
=== Account Properties
|
=== Account Properties
|
||||||
@ -256,7 +256,7 @@ matches the change and the event.
|
|||||||
SSH keys are stored in the user branch in an `authorized_keys` file,
|
SSH keys are stored in the user branch in an `authorized_keys` file,
|
||||||
which is the
|
which is the
|
||||||
link:https://en.wikibooks.org/wiki/OpenSSH/Client_Configuration_Files#.7E.2F.ssh.2Fauthorized_keys[
|
link:https://en.wikibooks.org/wiki/OpenSSH/Client_Configuration_Files#.7E.2F.ssh.2Fauthorized_keys[
|
||||||
standard OpenSSH file format] for storing SSH keys:
|
standard OpenSSH file format,role=external,window=_blank] for storing SSH keys:
|
||||||
|
|
||||||
----
|
----
|
||||||
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCgug5VyMXQGnem2H1KVC4/HcRcD4zzBqSuJBRWVonSSoz3RoAZ7bWXCVVGwchtXwUURD689wFYdiPecOrWOUgeeyRq754YWRhU+W28vf8IZixgjCmiBhaL2gt3wff6pP+NXJpTSA4aeWE5DfNK5tZlxlSxqkKOS8JRSUeNQov5Tw== john.doe@example.com
|
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCgug5VyMXQGnem2H1KVC4/HcRcD4zzBqSuJBRWVonSSoz3RoAZ7bWXCVVGwchtXwUURD689wFYdiPecOrWOUgeeyRq754YWRhU+W28vf8IZixgjCmiBhaL2gt3wff6pP+NXJpTSA4aeWE5DfNK5tZlxlSxqkKOS8JRSUeNQov5Tw== john.doe@example.com
|
||||||
|
@ -174,7 +174,7 @@ values are:
|
|||||||
+
|
+
|
||||||
The default setting. Gerrit uses any valid OpenID
|
The default setting. Gerrit uses any valid OpenID
|
||||||
provider chosen by the end-user. For more information see
|
provider chosen by the end-user. For more information see
|
||||||
http://openid.net/[openid.net].
|
http://openid.net/[openid.net,role=external,window=_blank].
|
||||||
+
|
+
|
||||||
* `OpenID_SSO`
|
* `OpenID_SSO`
|
||||||
+
|
+
|
||||||
@ -286,7 +286,7 @@ is set to `OpenID` (the default).
|
|||||||
+
|
+
|
||||||
Patterns may be either a
|
Patterns may be either a
|
||||||
link:http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html[standard
|
link:http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html[standard
|
||||||
Java regular expression (java.util.regex)] (start with `^` and
|
Java regular expression (java.util.regex),role=external,window=_blank] (start with `^` and
|
||||||
end with `$`) or be a simple prefix (any other string).
|
end with `$`) or be a simple prefix (any other string).
|
||||||
+
|
+
|
||||||
By default, the list contains two values, `http://` and `https://`,
|
By default, the list contains two values, `http://` and `https://`,
|
||||||
@ -304,7 +304,7 @@ pattern from this list.
|
|||||||
+
|
+
|
||||||
Patterns may be either a
|
Patterns may be either a
|
||||||
link:http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html[standard
|
link:http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html[standard
|
||||||
Java regular expression (java.util.regex)] (start with `^` and
|
Java regular expression (java.util.regex),role=external,window=_blank] (start with `^` and
|
||||||
end with `$`) or be a simple prefix (any other string).
|
end with `$`) or be a simple prefix (any other string).
|
||||||
+
|
+
|
||||||
By default, the list contains two values, `http://` and `https://`,
|
By default, the list contains two values, `http://` and `https://`,
|
||||||
@ -695,7 +695,7 @@ caused by the H2 database using too much memory.
|
|||||||
+
|
+
|
||||||
Technically the H2 cache size is configured using the CACHE_SIZE parameter in
|
Technically the H2 cache size is configured using the CACHE_SIZE parameter in
|
||||||
the H2 JDBC connection URL, as described
|
the H2 JDBC connection URL, as described
|
||||||
link:http://www.h2database.com/html/features.html#cache_settings[here]
|
link:http://www.h2database.com/html/features.html#cache_settings[here,role=external,window=_blank]
|
||||||
+
|
+
|
||||||
Default is unset, using up to half of the available memory.
|
Default is unset, using up to half of the available memory.
|
||||||
+
|
+
|
||||||
@ -708,7 +708,7 @@ Common unit suffixes of 'k', 'm', or 'g' are supported.
|
|||||||
If set to true, enable H2 autoserver mode for the H2-backed persistent cache
|
If set to true, enable H2 autoserver mode for the H2-backed persistent cache
|
||||||
databases.
|
databases.
|
||||||
+
|
+
|
||||||
See link:http://www.h2database.com/html/features.html#auto_mixed_mode[here]
|
See link:http://www.h2database.com/html/features.html#auto_mixed_mode[here,role=external,window=_blank]
|
||||||
for detail.
|
for detail.
|
||||||
+
|
+
|
||||||
Default is false.
|
Default is false.
|
||||||
@ -1712,7 +1712,7 @@ projects that allow content merges.
|
|||||||
+
|
+
|
||||||
As explained in this
|
As explained in this
|
||||||
link:http://codicesoftware.blogspot.com/2011/09/merge-recursive-strategy.html[
|
link:http://codicesoftware.blogspot.com/2011/09/merge-recursive-strategy.html[
|
||||||
blog], the recursive merge produces better results if the two commits
|
blog,role=external,window=_blank], the recursive merge produces better results if the two commits
|
||||||
that are merged have more than one common predecessor.
|
that are merged have more than one common predecessor.
|
||||||
+
|
+
|
||||||
Default is true.
|
Default is true.
|
||||||
@ -2245,9 +2245,9 @@ By default, Gerrit will use hexadecimal encoding for slashes in project and
|
|||||||
branch names. Some web servers, such as Tomcat, reject this hexadecimal
|
branch names. Some web servers, such as Tomcat, reject this hexadecimal
|
||||||
encoding in the URL.
|
encoding in the URL.
|
||||||
+
|
+
|
||||||
Some alternative gitweb services, such as link:http://gitblit.com[Gitblit],
|
Some alternative gitweb services, such as link:http://gitblit.com[Gitblit,role=external,window=_blank],
|
||||||
allow using an alternative path separator character. In Gitblit, this can be
|
allow using an alternative path separator character. In Gitblit, this can be
|
||||||
configured through the property link:http://gitblit.com/properties.html[web.forwardSlashCharacter].
|
configured through the property link:http://gitblit.com/properties.html[web.forwardSlashCharacter,role=external,window=_blank].
|
||||||
In Gerrit, the alternative path separator can be configured correspondingly
|
In Gerrit, the alternative path separator can be configured correspondingly
|
||||||
using the property `gitweb.pathSeparator`.
|
using the property `gitweb.pathSeparator`.
|
||||||
+
|
+
|
||||||
@ -2397,7 +2397,7 @@ supplied, defaults to 8080.
|
|||||||
Like `http://`, but additional header parsing features are
|
Like `http://`, but additional header parsing features are
|
||||||
enabled to honor `X-Forwarded-For`, `X-Forwarded-Host` and
|
enabled to honor `X-Forwarded-For`, `X-Forwarded-Host` and
|
||||||
`X-Forwarded-Server`. These headers are typically set by Apache's
|
`X-Forwarded-Server`. These headers are typically set by Apache's
|
||||||
link:https://httpd.apache.org/docs/2.4/mod/mod_proxy.html#x-headers[mod_proxy].
|
link:https://httpd.apache.org/docs/2.4/mod/mod_proxy.html#x-headers[mod_proxy,role=external,window=_blank].
|
||||||
+
|
+
|
||||||
[NOTE]
|
[NOTE]
|
||||||
--
|
--
|
||||||
@ -2748,7 +2748,7 @@ A link:http://lucene.apache.org/[Lucene] index is used.
|
|||||||
+
|
+
|
||||||
* `ELASTICSEARCH` look into link:#elasticsearch[Elasticsearch section]
|
* `ELASTICSEARCH` look into link:#elasticsearch[Elasticsearch section]
|
||||||
+
|
+
|
||||||
An link:https://www.elastic.co/products/elasticsearch[Elasticsearch] index is
|
An link:https://www.elastic.co/products/elasticsearch[Elasticsearch,role=external,window=_blank] index is
|
||||||
used. Refer to the link:#elasticsearch[Elasticsearch section] for further
|
used. Refer to the link:#elasticsearch[Elasticsearch section] for further
|
||||||
configuration details.
|
configuration details.
|
||||||
|
|
||||||
@ -2912,7 +2912,7 @@ The following settings are only used when the index type is `LUCENE`.
|
|||||||
Determines the amount of RAM that may be used for buffering added documents
|
Determines the amount of RAM that may be used for buffering added documents
|
||||||
and deletions before they are flushed to the index. See the
|
and deletions before they are flushed to the index. See the
|
||||||
link:http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/index/LiveIndexWriterConfig.html#setRAMBufferSizeMB(double)[
|
link:http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/index/LiveIndexWriterConfig.html#setRAMBufferSizeMB(double)[
|
||||||
Lucene documentation] for further details.
|
Lucene documentation,role=external,window=_blank] for further details.
|
||||||
+
|
+
|
||||||
Defaults to 16M.
|
Defaults to 16M.
|
||||||
|
|
||||||
@ -2922,7 +2922,7 @@ Determines the minimal number of documents required before the buffered
|
|||||||
in-memory documents are flushed to the index. Large values generally
|
in-memory documents are flushed to the index. Large values generally
|
||||||
give faster indexing. See the
|
give faster indexing. See the
|
||||||
link:http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/index/LiveIndexWriterConfig.html#setMaxBufferedDocs(int)[
|
link:http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/index/LiveIndexWriterConfig.html#setMaxBufferedDocs(int)[
|
||||||
Lucene documentation] for further details.
|
Lucene documentation,role=external,window=_blank] for further details.
|
||||||
+
|
+
|
||||||
Defaults to -1, meaning no maximum is set and the writer will flush
|
Defaults to -1, meaning no maximum is set and the writer will flush
|
||||||
according to RAM usage.
|
according to RAM usage.
|
||||||
@ -2955,7 +2955,7 @@ is necessary yet we already have this many threads running, the incoming thread
|
|||||||
completed. Note that Lucene will only run the smallest maxThreadCount merges
|
completed. Note that Lucene will only run the smallest maxThreadCount merges
|
||||||
at a time. See the
|
at a time. See the
|
||||||
link:https://lucene.apache.org/core/5_5_0/core/org/apache/lucene/index/ConcurrentMergeScheduler.html#setDefaultMaxMergesAndThreads(boolean)[
|
link:https://lucene.apache.org/core/5_5_0/core/org/apache/lucene/index/ConcurrentMergeScheduler.html#setDefaultMaxMergesAndThreads(boolean)[
|
||||||
Lucene documentation] for further details.
|
Lucene documentation,role=external,window=_blank] for further details.
|
||||||
+
|
+
|
||||||
Defaults to -1 for (auto detection).
|
Defaults to -1 for (auto detection).
|
||||||
|
|
||||||
@ -2965,13 +2965,13 @@ Defaults to -1 for (auto detection).
|
|||||||
Determines the max number of simultaneous Lucene merge threads that should be running at
|
Determines the max number of simultaneous Lucene merge threads that should be running at
|
||||||
once. This must be less than or equal to maxMergeCount. See the
|
once. This must be less than or equal to maxMergeCount. See the
|
||||||
link:https://lucene.apache.org/core/5_5_0/core/org/apache/lucene/index/ConcurrentMergeScheduler.html#setDefaultMaxMergesAndThreads(boolean)[
|
link:https://lucene.apache.org/core/5_5_0/core/org/apache/lucene/index/ConcurrentMergeScheduler.html#setDefaultMaxMergesAndThreads(boolean)[
|
||||||
Lucene documentation] for further details.
|
Lucene documentation,role=external,window=_blank] for further details.
|
||||||
+
|
+
|
||||||
For further details on Lucene index configuration (auto detection) which
|
For further details on Lucene index configuration (auto detection) which
|
||||||
affects maxThreadCount and maxMergeCount settings.
|
affects maxThreadCount and maxMergeCount settings.
|
||||||
See the
|
See the
|
||||||
link:https://lucene.apache.org/core/5_5_0/core/org/apache/lucene/index/ConcurrentMergeScheduler.html#AUTO_DETECT_MERGES_AND_THREADS[
|
link:https://lucene.apache.org/core/5_5_0/core/org/apache/lucene/index/ConcurrentMergeScheduler.html#AUTO_DETECT_MERGES_AND_THREADS[
|
||||||
Lucene documentation]
|
Lucene documentation,role=external,window=_blank]
|
||||||
+
|
+
|
||||||
Defaults to -1 for (auto detection).
|
Defaults to -1 for (auto detection).
|
||||||
|
|
||||||
@ -2982,7 +2982,7 @@ default in the lucene merge queue. Automatic dynamic IO throttling, which when
|
|||||||
on is used to adaptively rate limit writes bytes/sec to the minimal rate necessary
|
on is used to adaptively rate limit writes bytes/sec to the minimal rate necessary
|
||||||
so merges do not fall behind. See the
|
so merges do not fall behind. See the
|
||||||
link:https://lucene.apache.org/core/5_5_0/core/org/apache/lucene/index/ConcurrentMergeScheduler.html#enableAutoIOThrottle()[
|
link:https://lucene.apache.org/core/5_5_0/core/org/apache/lucene/index/ConcurrentMergeScheduler.html#enableAutoIOThrottle()[
|
||||||
Lucene documentation] for further details.
|
Lucene documentation,role=external,window=_blank] for further details.
|
||||||
+
|
+
|
||||||
Defaults to true (throttling enabled).
|
Defaults to true (throttling enabled).
|
||||||
|
|
||||||
@ -3012,7 +3012,7 @@ Sample Lucene index configuration:
|
|||||||
|
|
||||||
WARNING: Support for Elasticsearch is still experimental and is not recommended
|
WARNING: Support for Elasticsearch is still experimental and is not recommended
|
||||||
for production use. For compatibility information, please refer to the
|
for production use. For compatibility information, please refer to the
|
||||||
link:https://www.gerritcodereview.com/elasticsearch.html[project homepage].
|
link:https://www.gerritcodereview.com/elasticsearch.html[project homepage,role=external,window=_blank].
|
||||||
|
|
||||||
When using Elasticsearch version 5.6, the open and closed changes are
|
When using Elasticsearch version 5.6, the open and closed changes are
|
||||||
indexed in a single index, separated into types `open_changes` and `closed_changes`
|
indexed in a single index, separated into types `open_changes` and `closed_changes`
|
||||||
@ -3047,7 +3047,7 @@ manually.
|
|||||||
+
|
+
|
||||||
Sets the number of shards to use per index. Refer to the
|
Sets the number of shards to use per index. Refer to the
|
||||||
link:https://www.elastic.co/guide/en/elasticsearch/reference/current/getting-started-concepts.html#getting-started-shards-and-replicas[
|
link:https://www.elastic.co/guide/en/elasticsearch/reference/current/getting-started-concepts.html#getting-started-shards-and-replicas[
|
||||||
Elasticsearch documentation] for details.
|
Elasticsearch documentation,role=external,window=_blank] for details.
|
||||||
+
|
+
|
||||||
Defaults to 5 for Elasticsearch versions 5 and 6, and to 1 starting with Elasticsearch 7.
|
Defaults to 5 for Elasticsearch versions 5 and 6, and to 1 starting with Elasticsearch 7.
|
||||||
|
|
||||||
@ -3055,7 +3055,7 @@ Defaults to 5 for Elasticsearch versions 5 and 6, and to 1 starting with Elastic
|
|||||||
+
|
+
|
||||||
Sets the number of replicas to use per index. Refer to the
|
Sets the number of replicas to use per index. Refer to the
|
||||||
link:https://www.elastic.co/guide/en/elasticsearch/reference/current/getting-started-concepts.html#getting-started-shards-and-replicas[
|
link:https://www.elastic.co/guide/en/elasticsearch/reference/current/getting-started-concepts.html#getting-started-shards-and-replicas[
|
||||||
Elasticsearch documentation] for details.
|
Elasticsearch documentation,role=external,window=_blank] for details.
|
||||||
+
|
+
|
||||||
Defaults to 1.
|
Defaults to 1.
|
||||||
|
|
||||||
@ -3066,12 +3066,12 @@ Note that the same username and password are used for all servers.
|
|||||||
|
|
||||||
For further information about Elasticsearch security, please refer to the documentation:
|
For further information about Elasticsearch security, please refer to the documentation:
|
||||||
|
|
||||||
* link:https://www.elastic.co/guide/en/x-pack/5.6/security-getting-started.html[Elasticsearch 5.6]
|
* link:https://www.elastic.co/guide/en/x-pack/5.6/security-getting-started.html[Elasticsearch 5.6,role=external,window=_blank]
|
||||||
* link:https://www.elastic.co/guide/en/x-pack/6.2/security-getting-started.html[Elasticsearch 6.2]
|
* link:https://www.elastic.co/guide/en/x-pack/6.2/security-getting-started.html[Elasticsearch 6.2,role=external,window=_blank]
|
||||||
* link:https://www.elastic.co/guide/en/elastic-stack-overview/6.3/security-getting-started.html[Elasticsearch 6.3]
|
* link:https://www.elastic.co/guide/en/elastic-stack-overview/6.3/security-getting-started.html[Elasticsearch 6.3,role=external,window=_blank]
|
||||||
* link:https://www.elastic.co/guide/en/elastic-stack-overview/6.4/security-getting-started.html[Elasticsearch 6.4]
|
* link:https://www.elastic.co/guide/en/elastic-stack-overview/6.4/security-getting-started.html[Elasticsearch 6.4,role=external,window=_blank]
|
||||||
* link:https://www.elastic.co/guide/en/elastic-stack-overview/6.5/security-getting-started.html[Elasticsearch 6.5]
|
* link:https://www.elastic.co/guide/en/elastic-stack-overview/6.5/security-getting-started.html[Elasticsearch 6.5,role=external,window=_blank]
|
||||||
* link:https://www.elastic.co/guide/en/elastic-stack-overview/6.6/security-getting-started.html[Elasticsearch 6.6]
|
* link:https://www.elastic.co/guide/en/elastic-stack-overview/6.6/security-getting-started.html[Elasticsearch 6.6,role=external,window=_blank]
|
||||||
|
|
||||||
[[elasticsearch.username]]elasticsearch.username::
|
[[elasticsearch.username]]elasticsearch.username::
|
||||||
+
|
+
|
||||||
@ -3122,8 +3122,8 @@ An example LDAP configuration follows, and then discussion of
|
|||||||
the parameters introduced here. Suitable defaults for most
|
the parameters introduced here. Suitable defaults for most
|
||||||
parameters are automatically guessed based on the type of server
|
parameters are automatically guessed based on the type of server
|
||||||
detected during startup. The guessed defaults support
|
detected during startup. The guessed defaults support
|
||||||
link:http://www.ietf.org/rfc/rfc2307.txt[RFC 2307], Active
|
link:http://www.ietf.org/rfc/rfc2307.txt[RFC 2307,role=external,window=_blank], Active
|
||||||
Directory and link:https://www.freeipa.org[FreeIPA].
|
Directory and link:https://www.freeipa.org[FreeIPA,role=external,window=_blank].
|
||||||
|
|
||||||
----
|
----
|
||||||
[ldap]
|
[ldap]
|
||||||
@ -3477,8 +3477,8 @@ needed. When a Context instance is done with a connection (closed or
|
|||||||
garbage collected), the connection is returned to the pool for future use.
|
garbage collected), the connection is returned to the pool for future use.
|
||||||
+
|
+
|
||||||
For details, see link:http://docs.oracle.com/javase/tutorial/jndi/ldap/pool.html[
|
For details, see link:http://docs.oracle.com/javase/tutorial/jndi/ldap/pool.html[
|
||||||
LDAP connection management (Pool)] and link:http://docs.oracle.com/javase/tutorial/jndi/ldap/config.html[
|
LDAP connection management (Pool),role=external,window=_blank] and link:http://docs.oracle.com/javase/tutorial/jndi/ldap/config.html[
|
||||||
LDAP connection management (Configuration)]
|
LDAP connection management (Configuration),role=external,window=_blank]
|
||||||
+
|
+
|
||||||
By default, false.
|
By default, false.
|
||||||
|
|
||||||
@ -3497,7 +3497,7 @@ Once LDAP connection pooling is enabled by setting the link:#ldap.useConnectionP
|
|||||||
ldap.useConnectionPooling] configuration property to `true`, the connection pool
|
ldap.useConnectionPooling] configuration property to `true`, the connection pool
|
||||||
can be configured using JVM system properties as explained in the
|
can be configured using JVM system properties as explained in the
|
||||||
link:http://docs.oracle.com/javase/7/docs/technotes/guides/jndi/jndi-ldap.html#POOL[
|
link:http://docs.oracle.com/javase/7/docs/technotes/guides/jndi/jndi-ldap.html#POOL[
|
||||||
Java SE Documentation].
|
Java SE Documentation,role=external,window=_blank].
|
||||||
|
|
||||||
For standalone Gerrit (running with the embedded Jetty), JVM system properties
|
For standalone Gerrit (running with the embedded Jetty), JVM system properties
|
||||||
are specified in the link:#container[container section]:
|
are specified in the link:#container[container section]:
|
||||||
@ -3515,7 +3515,7 @@ are specified in the link:#container[container section]:
|
|||||||
+
|
+
|
||||||
The name of a plugin which serves the
|
The name of a plugin which serves the
|
||||||
link:https://github.com/github/git-lfs/blob/master/docs/api/v1/http-v1-batch.md[
|
link:https://github.com/github/git-lfs/blob/master/docs/api/v1/http-v1-batch.md[
|
||||||
LFS protocol] on the `<project-name>/info/lfs/objects/batch` endpoint. When
|
LFS protocol,role=external,window=_blank] on the `<project-name>/info/lfs/objects/batch` endpoint. When
|
||||||
not configured Gerrit will respond with `501 Not Implemented` on LFS protocol
|
not configured Gerrit will respond with `501 Not Implemented` on LFS protocol
|
||||||
requests.
|
requests.
|
||||||
+
|
+
|
||||||
@ -3926,7 +3926,7 @@ Key fingerprints can be displayed with `gpg --list-keys
|
|||||||
+
|
+
|
||||||
Trust signatures can be added to a key using the `tsign` command to
|
Trust signatures can be added to a key using the `tsign` command to
|
||||||
link:https://www.gnupg.org/documentation/manuals/gnupg/OpenPGP-Key-Management.html[
|
link:https://www.gnupg.org/documentation/manuals/gnupg/OpenPGP-Key-Management.html[
|
||||||
`gpg --edit-key`], after which the signed key should be re-uploaded.
|
`gpg --edit-key`,role=external,window=_blank], after which the signed key should be re-uploaded.
|
||||||
+
|
+
|
||||||
If no keys are specified, web-of-trust checks are disabled. This is the
|
If no keys are specified, web-of-trust checks are disabled. This is the
|
||||||
default behavior.
|
default behavior.
|
||||||
@ -4379,7 +4379,7 @@ Reply-To if inbound email is enabled and the review's author otherwise.
|
|||||||
[[sendemail.allowTLD]]sendemail.allowTLD::
|
[[sendemail.allowTLD]]sendemail.allowTLD::
|
||||||
+
|
+
|
||||||
List of custom TLDs to allow sending emails to in addition to those specified
|
List of custom TLDs to allow sending emails to in addition to those specified
|
||||||
in the link:http://data.iana.org/TLD/[IANA list].
|
in the link:http://data.iana.org/TLD/[IANA list,role=external,window=_blank].
|
||||||
+
|
+
|
||||||
Defaults to an empty list, meaning no additional TLDs are allowed.
|
Defaults to an empty list, meaning no additional TLDs are allowed.
|
||||||
|
|
||||||
@ -4889,7 +4889,7 @@ The trailing ":" is optional.
|
|||||||
[[trackingid.name.match]]trackingid.<name>.match::
|
[[trackingid.name.match]]trackingid.<name>.match::
|
||||||
+
|
+
|
||||||
A link:http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html[standard
|
A link:http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html[standard
|
||||||
Java regular expression (java.util.regex)] used to match the
|
Java regular expression (java.util.regex),role=external,window=_blank] used to match the
|
||||||
external tracking id part of the footer line. The match can
|
external tracking id part of the footer line. The match can
|
||||||
result in several entries in the DB. If grouping is used in the
|
result in several entries in the DB. If grouping is used in the
|
||||||
regex the first group will be interpreted as the tracking id.
|
regex the first group will be interpreted as the tracking id.
|
||||||
|
@ -167,21 +167,21 @@ link:http://localhost/gitweb[http://localhost/gitweb]
|
|||||||
Instructions are available for installing the gitweb module distributed with
|
Instructions are available for installing the gitweb module distributed with
|
||||||
MsysGit:
|
MsysGit:
|
||||||
|
|
||||||
link:https://github.com/msysgit/msysgit/wiki/GitWeb[GitWeb]
|
link:https://github.com/msysgit/msysgit/wiki/GitWeb[GitWeb,role=external,window=_blank]
|
||||||
|
|
||||||
If you don't have Apache installed, you can download the appropriate build for
|
If you don't have Apache installed, you can download the appropriate build for
|
||||||
Windows from link:http://www.apachelounge.com/download[apachelounge.org].
|
Windows from link:http://www.apachelounge.com/download[apachelounge.org].
|
||||||
|
|
||||||
After you have installed Apache, you will want to create a link:http://httpd.apache.org/docs/2.0/platform/windows.html#winsvc[new service user
|
After you have installed Apache, you will want to create a link:http://httpd.apache.org/docs/2.0/platform/windows.html#winsvc[new service user
|
||||||
account] to use with Apache.
|
account,role=external,window=_blank] to use with Apache.
|
||||||
|
|
||||||
If you're still having difficulty setting up permissions, you may find this
|
If you're still having difficulty setting up permissions, you may find this
|
||||||
tech note useful for configuring Apache Service to run under another account.
|
tech note useful for configuring Apache Service to run under another account.
|
||||||
You must grant the new account link:http://technet.microsoft.com/en-us/library/cc794944(WS.10).aspx["run as service"] permission:
|
You must grant the new account link:http://technet.microsoft.com/en-us/library/cc794944(WS.10).aspx["run as service",role=external,window=_blank] permission:
|
||||||
|
|
||||||
The gitweb version in msysgit is missing several important and required
|
The gitweb version in msysgit is missing several important and required
|
||||||
perl modules, including CGI.pm. The perl included with the msysgit distro 1.7.8
|
perl modules, including CGI.pm. The perl included with the msysgit distro 1.7.8
|
||||||
is broken.. The link:http://groups.google.com/group/msysgit/browse_thread/thread/ba3501f1f0ed95af[unicore folder is missing along with utf8_heavy.pl and CGI.pm]. You can
|
is broken.. The link:http://groups.google.com/group/msysgit/browse_thread/thread/ba3501f1f0ed95af[unicore folder is missing along with utf8_heavy.pl and CGI.pm,role=external,window=_blank]. You can
|
||||||
verify by checking for perl modules. From an msys console, execute the
|
verify by checking for perl modules. From an msys console, execute the
|
||||||
following to check:
|
following to check:
|
||||||
|
|
||||||
@ -202,7 +202,7 @@ failed--compilation aborted.
|
|||||||
If you're missing CGI.pm, you'll have to deploy the module to the msys
|
If you're missing CGI.pm, you'll have to deploy the module to the msys
|
||||||
environment: You will have to retrieve them from the 5.8.8 distro on :
|
environment: You will have to retrieve them from the 5.8.8 distro on :
|
||||||
|
|
||||||
http://strawberryperl.com/releases.html
|
http://strawberryperl.com/releases.html[role=external,window=_blank]
|
||||||
|
|
||||||
File: strawberry-perl-5.8.8.3.zip
|
File: strawberry-perl-5.8.8.3.zip
|
||||||
|
|
||||||
@ -272,7 +272,7 @@ It is also possible to define custom patterns.
|
|||||||
=== SEE ALSO
|
=== SEE ALSO
|
||||||
|
|
||||||
* link:config-gerrit.html#gitweb[Section gitweb]
|
* link:config-gerrit.html#gitweb[Section gitweb]
|
||||||
* link:http://git.zx2c4.com/cgit/about/[cgit]
|
* link:http://git.zx2c4.com/cgit/about/[cgit,role=external,window=_blank]
|
||||||
|
|
||||||
GERRIT
|
GERRIT
|
||||||
------
|
------
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
Gerrit does not run any of the standard git hooks in the repositories
|
Gerrit does not run any of the standard git hooks in the repositories
|
||||||
it works with, but it does have its own hook mechanism included via
|
it works with, but it does have its own hook mechanism included via
|
||||||
the link:https://gerrit-review.googlesource.com/admin/repos/plugins/hooks[
|
the link:https://gerrit-review.googlesource.com/admin/repos/plugins/hooks[
|
||||||
hooks plugin].
|
hooks plugin,role=external,window=_blank].
|
||||||
|
|
||||||
GERRIT
|
GERRIT
|
||||||
------
|
------
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
= Gerrit Code Review - Mail Templates
|
= Gerrit Code Review - Mail Templates
|
||||||
|
|
||||||
Gerrit uses link:https://developers.google.com/closure/templates/[Closure Templates]
|
Gerrit uses link:https://developers.google.com/closure/templates/[Closure Templates,role=external,window=_blank]
|
||||||
(Soy) for the bulk of the standard mails it sends out.
|
(Soy) for the bulk of the standard mails it sends out.
|
||||||
There are builtin default templates which are used if they are not overridden.
|
There are builtin default templates which are used if they are not overridden.
|
||||||
These defaults are also provided as examples so that administrators may copy
|
These defaults are also provided as examples so that administrators may copy
|
||||||
|
@ -25,10 +25,10 @@ Plugin Development Guide].
|
|||||||
|
|
||||||
If you want to share your plugin under the link:licenses.html#Apache2_0[
|
If you want to share your plugin under the link:licenses.html#Apache2_0[
|
||||||
Apache License 2.0] you can host your plugin development on the
|
Apache License 2.0] you can host your plugin development on the
|
||||||
link:https://gerrit-review.googlesource.com[gerrit-review] Gerrit
|
link:https://gerrit-review.googlesource.com[gerrit-review,role=external,window=_blank] Gerrit
|
||||||
Server. You can request the creation of a new Project by email
|
Server. You can request the creation of a new Project by email
|
||||||
to the link:https://groups.google.com/forum/#!forum/repo-discuss[Gerrit
|
to the link:https://groups.google.com/forum/#!forum/repo-discuss[Gerrit
|
||||||
mailing list]. You would be assigned as project owner of the new plugin
|
mailing list,role=external,window=_blank]. You would be assigned as project owner of the new plugin
|
||||||
project so that you can submit changes on your own. It is the
|
project so that you can submit changes on your own. It is the
|
||||||
responsibility of the project owner to maintain the plugin, e.g. to
|
responsibility of the project owner to maintain the plugin, e.g. to
|
||||||
make sure that it works with new Gerrit versions and to create stable
|
make sure that it works with new Gerrit versions and to create stable
|
||||||
@ -51,7 +51,7 @@ revision for the Gerrit version you are using.
|
|||||||
CodeMirror plugin for polygerrit.
|
CodeMirror plugin for polygerrit.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/codemirror-editor[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/codemirror-editor[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
|
|
||||||
[[commit-message-length-validator]]
|
[[commit-message-length-validator]]
|
||||||
=== commit-message-length-validator
|
=== commit-message-length-validator
|
||||||
@ -61,11 +61,11 @@ message body, and reports warnings or errors to the git client if the
|
|||||||
lengths are exceeded.
|
lengths are exceeded.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/commit-message-length-validator[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/commit-message-length-validator[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/commit-message-length-validator/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/commit-message-length-validator/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/commit-message-length-validator/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/commit-message-length-validator/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[delete-project]]
|
[[delete-project]]
|
||||||
=== delete-project
|
=== delete-project
|
||||||
@ -73,11 +73,11 @@ Configuration]
|
|||||||
Provides the ability to delete a project.
|
Provides the ability to delete a project.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/delete-project[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/delete-project[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/delete-project/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/delete-project/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/delete-project/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/delete-project/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[download-commands]]
|
[[download-commands]]
|
||||||
=== download-commands
|
=== download-commands
|
||||||
@ -86,11 +86,11 @@ This plugin defines commands for downloading changes in different
|
|||||||
download schemes (for downloading via different network protocols).
|
download schemes (for downloading via different network protocols).
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/download-commands[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/download-commands[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/download-commands/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/download-commands/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/download-commands/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/download-commands/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[gitiles]]
|
[[gitiles]]
|
||||||
=== gitiles
|
=== gitiles
|
||||||
@ -98,7 +98,7 @@ Configuration]
|
|||||||
Plugin running Gitiles alongside a Gerrit server.
|
Plugin running Gitiles alongside a Gerrit server.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/gitiles[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/gitiles[
|
||||||
Project]
|
Project,role=external,window=_blank]
|
||||||
|
|
||||||
[[hooks]]
|
[[hooks]]
|
||||||
=== hooks
|
=== hooks
|
||||||
@ -106,11 +106,11 @@ Project]
|
|||||||
This plugin runs server-side hooks on events.
|
This plugin runs server-side hooks on events.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/hooks[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/hooks[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/hooks/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/hooks/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/hooks/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/hooks/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[plugin-manager]]
|
[[plugin-manager]]
|
||||||
=== plugin-manager
|
=== plugin-manager
|
||||||
@ -120,11 +120,11 @@ Per default GerritForge CI is used to download the plugin artifacts from, but
|
|||||||
this can be changed per plugin configuration.
|
this can be changed per plugin configuration.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/plugin-manager[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/plugin-manager[
|
||||||
Project]
|
Project,role=external,window=_blank]
|
||||||
link:https://gerrit.googlesource.com/plugins/plugin-manager/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/plugin-manager/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation]
|
Documentation,role=external,window=_blank]
|
||||||
link:https://gerrit.googlesource.com/plugins/plugin-manager/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/plugin-manager/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[replication]]
|
[[replication]]
|
||||||
=== replication
|
=== replication
|
||||||
@ -135,11 +135,11 @@ be configured to provide mirroring of changes, for warm-standby
|
|||||||
backups, or a load-balanced public mirror farm.
|
backups, or a load-balanced public mirror farm.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/replication[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/replication[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/replication/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/replication/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/replication/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/replication/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[reviewnotes]]
|
[[reviewnotes]]
|
||||||
=== reviewnotes
|
=== reviewnotes
|
||||||
@ -148,9 +148,9 @@ Stores review information for Gerrit changes in the `refs/notes/review`
|
|||||||
branch.
|
branch.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/reviewnotes[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/reviewnotes[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/reviewnotes/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/reviewnotes/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation]
|
Documentation,role=external,window=_blank]
|
||||||
|
|
||||||
[[singleusergroup]]
|
[[singleusergroup]]
|
||||||
=== singleusergroup
|
=== singleusergroup
|
||||||
@ -165,11 +165,11 @@ only be assigned to groups.
|
|||||||
This plugin allows to propagate Gerrit events to remote http endpoints.
|
This plugin allows to propagate Gerrit events to remote http endpoints.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/webhooks[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/webhooks[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/webhooks/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/webhooks/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/webhooks/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/webhooks/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[other-plugins]]
|
[[other-plugins]]
|
||||||
== Other Plugins
|
== Other Plugins
|
||||||
@ -183,12 +183,12 @@ The Gerrit Project doesn't provide binaries for these plugins, but
|
|||||||
there is one public service that offers the download of pre-built
|
there is one public service that offers the download of pre-built
|
||||||
plugin jars:
|
plugin jars:
|
||||||
|
|
||||||
* link:https://gerrit-ci.gerritforge.com[CI Server from GerritForge]
|
* link:https://gerrit-ci.gerritforge.com[CI Server from GerritForge,role=external,window=_blank]
|
||||||
|
|
||||||
The following list gives an overview of available plugins, but the
|
The following list gives an overview of available plugins, but the
|
||||||
list may not be complete. You may discover more plugins on
|
list may not be complete. You may discover more plugins on
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/?filter=plugins%252F[
|
link:https://gerrit-review.googlesource.com/admin/repos/?filter=plugins%252F[
|
||||||
gerrit-review].
|
gerrit-review,role=external,window=_blank].
|
||||||
|
|
||||||
Note that the documentation and configuration links in the list below are
|
Note that the documentation and configuration links in the list below are
|
||||||
to the plugins' master branch. Please refer to the appropriate branch for
|
to the plugins' master branch. Please refer to the appropriate branch for
|
||||||
@ -205,9 +205,9 @@ information. Also providing access control information by project or
|
|||||||
project/account.
|
project/account.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/admin-console[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/admin-console[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/admin-console/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/admin-console/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation]
|
Documentation,role=external,window=_blank]
|
||||||
|
|
||||||
[[analytics]]
|
[[analytics]]
|
||||||
=== analytics
|
=== analytics
|
||||||
@ -218,8 +218,8 @@ Metrics are extracted in JSON format with one record per line, ready to be
|
|||||||
archived and processed with popular BigData transformation tools such
|
archived and processed with popular BigData transformation tools such
|
||||||
Apache Spark or published and visualized in dashboards.
|
Apache Spark or published and visualized in dashboards.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/analytics[Project] |
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/analytics[Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/analytics/+doc/master/README.md[Documentation]
|
link:https://gerrit.googlesource.com/plugins/analytics/+doc/master/README.md[Documentation,role=external,window=_blank]
|
||||||
|
|
||||||
[[avatars-external]]
|
[[avatars-external]]
|
||||||
=== avatars-external
|
=== avatars-external
|
||||||
@ -228,11 +228,11 @@ This plugin allows to use an external url to load the avatar images
|
|||||||
from.
|
from.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/avatars-external[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/avatars-external[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/avatars-external/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/avatars-external/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/avatars-external/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/avatars-external/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[avatars-gravatar]]
|
[[avatars-gravatar]]
|
||||||
=== avatars-gravatar
|
=== avatars-gravatar
|
||||||
@ -240,7 +240,7 @@ Configuration]
|
|||||||
Plugin to display user icons from Gravatar.
|
Plugin to display user icons from Gravatar.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/avatars-gravatar[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/avatars-gravatar[
|
||||||
Project]
|
Project,role=external,window=_blank]
|
||||||
|
|
||||||
[[branch-network]]
|
[[branch-network]]
|
||||||
=== branch-network
|
=== branch-network
|
||||||
@ -250,11 +250,11 @@ graphical HTML5 Canvas. It is mainly intended to be used as a
|
|||||||
"project link" in a gitweb configuration.
|
"project link" in a gitweb configuration.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/branch-network[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/branch-network[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/branch-network/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/branch-network/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/branch-network/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/branch-network/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[changemessage]]
|
[[changemessage]]
|
||||||
=== changemessage
|
=== changemessage
|
||||||
@ -262,11 +262,11 @@ Configuration]
|
|||||||
This plugin allows to display a static info message on the change screen.
|
This plugin allows to display a static info message on the change screen.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/changemessage[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/changemessage[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/changemessage/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/changemessage/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Plugin Documentation] |
|
Plugin Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/changemessage/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/changemessage/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[checks]]
|
[[checks]]
|
||||||
=== checks
|
=== checks
|
||||||
@ -275,9 +275,9 @@ The checks plugin provides a REST API and UI extensions for integrating
|
|||||||
CI systems with Gerrit.
|
CI systems with Gerrit.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/checks[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/checks[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/checks/+doc/master/README.md[
|
link:https://gerrit.googlesource.com/plugins/checks/+doc/master/README.md[
|
||||||
Plugin Documentation]
|
Plugin Documentation,role=external,window=_blank]
|
||||||
|
|
||||||
[[egit]]
|
[[egit]]
|
||||||
=== egit
|
=== egit
|
||||||
@ -289,9 +289,9 @@ the change ref into the clipboard. The change ref is needed for
|
|||||||
downloading a Gerrit change from within EGit.
|
downloading a Gerrit change from within EGit.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/egit[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/egit[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/egit/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/egit/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation]
|
Documentation,role=external,window=_blank]
|
||||||
|
|
||||||
[[emoticons]]
|
[[emoticons]]
|
||||||
=== emoticons
|
=== emoticons
|
||||||
@ -299,11 +299,11 @@ Documentation]
|
|||||||
This plugin allows users to see emoticons in comments as images.
|
This plugin allows users to see emoticons in comments as images.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/emoticons[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/emoticons[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/emoticons/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/emoticons/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/emoticons/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/emoticons/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[find-owners]]
|
[[find-owners]]
|
||||||
=== find-owners
|
=== find-owners
|
||||||
@ -312,9 +312,9 @@ that shows owners of changed files to be included as code reviewers, and
|
|||||||
(2) Prolog predicates to make sure that a CL is submittable
|
(2) Prolog predicates to make sure that a CL is submittable
|
||||||
only with owner Code-Review +1 votes.
|
only with owner Code-Review +1 votes.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/find-owners[Project] |
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/find-owners[Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/find-owners/+doc/master/src/main/resources/Documentation/about.md[Documentation] |
|
link:https://gerrit.googlesource.com/plugins/find-owners/+doc/master/src/main/resources/Documentation/about.md[Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/find-owners/+doc/master/src/main/resources/Documentation/config.md[Configuration]
|
link:https://gerrit.googlesource.com/plugins/find-owners/+doc/master/src/main/resources/Documentation/config.md[Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[gitblit]]
|
[[gitblit]]
|
||||||
=== gitblit
|
=== gitblit
|
||||||
@ -322,7 +322,7 @@ link:https://gerrit.googlesource.com/plugins/find-owners/+doc/master/src/main/re
|
|||||||
GitBlit code-viewer plugin with SSO and Security Access Control.
|
GitBlit code-viewer plugin with SSO and Security Access Control.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/gitblit[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/gitblit[
|
||||||
Project]
|
Project,role=external,window=_blank]
|
||||||
|
|
||||||
[[github]]
|
[[github]]
|
||||||
=== github
|
=== github
|
||||||
@ -330,7 +330,7 @@ Project]
|
|||||||
Plugin to integrate with GitHub: replication, pull-request to Change-Sets
|
Plugin to integrate with GitHub: replication, pull-request to Change-Sets
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/github[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/github[
|
||||||
Project]
|
Project,role=external,window=_blank]
|
||||||
|
|
||||||
[[healthcheck]]
|
[[healthcheck]]
|
||||||
=== healthcheck
|
=== healthcheck
|
||||||
@ -346,11 +346,11 @@ Healthcheck metrics (latency and subsystem healthiness) are published as
|
|||||||
Gerrit internal metrics and can be published to dashboards.
|
Gerrit internal metrics and can be published to dashboards.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/healthcheck[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/healthcheck[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/healthcheck/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/healthcheck/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/healthcheck/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/healthcheck/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[imagare]]
|
[[imagare]]
|
||||||
=== imagare
|
=== imagare
|
||||||
@ -358,11 +358,11 @@ Configuration]
|
|||||||
The imagare plugin allows Gerrit users to upload and share images.
|
The imagare plugin allows Gerrit users to upload and share images.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/imagare[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/imagare[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/imagare/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/imagare/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/imagare/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/imagare/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[importer]]
|
[[importer]]
|
||||||
=== importer
|
=== importer
|
||||||
@ -386,9 +386,9 @@ server, and in combination with the link:#delete-project[delete-project]
|
|||||||
plugin it can be used to rename a project.
|
plugin it can be used to rename a project.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/importer[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/importer[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/importer/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/importer/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation]
|
Documentation,role=external,window=_blank]
|
||||||
|
|
||||||
[[its-plugins]]
|
[[its-plugins]]
|
||||||
=== Issue Tracker System Plugins
|
=== Issue Tracker System Plugins
|
||||||
@ -402,11 +402,11 @@ the `its-base` project. `its-base` is not a plugin, but just a
|
|||||||
framework for the ITS plugins which is packaged within each ITS plugin.
|
framework for the ITS plugins which is packaged within each ITS plugin.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/its-base[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/its-base[
|
||||||
its-base Project] |
|
its-base Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/its-base/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/its-base/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
its-base Documentation] |
|
its-base Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/its-base/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/its-base/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
its-base Configuration]
|
its-base Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[its-bugzilla]]
|
[[its-bugzilla]]
|
||||||
==== its-bugzilla
|
==== its-bugzilla
|
||||||
@ -414,9 +414,9 @@ its-base Configuration]
|
|||||||
Plugin to integrate with Bugzilla.
|
Plugin to integrate with Bugzilla.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/its-bugzilla[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/its-bugzilla[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/its-bugzilla/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/its-bugzilla/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation]
|
Documentation,role=external,window=_blank]
|
||||||
|
|
||||||
[[its-jira]]
|
[[its-jira]]
|
||||||
==== its-jira
|
==== its-jira
|
||||||
@ -424,9 +424,9 @@ Documentation]
|
|||||||
Plugin to integrate with Jira.
|
Plugin to integrate with Jira.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/its-jira[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/its-jira[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/its-jira/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/its-jira/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[its-phabricator]]
|
[[its-phabricator]]
|
||||||
==== its-phabricator
|
==== its-phabricator
|
||||||
@ -434,9 +434,9 @@ Configuration]
|
|||||||
Plugin to integrate with Phabricator.
|
Plugin to integrate with Phabricator.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/its-phabricator[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/its-phabricator[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/its-phabricator/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/its-phabricator/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[its-rtc]]
|
[[its-rtc]]
|
||||||
==== its-rtc
|
==== its-rtc
|
||||||
@ -444,9 +444,9 @@ Configuration]
|
|||||||
Plugin to integrate with IBM Rational Team Concert (RTC).
|
Plugin to integrate with IBM Rational Team Concert (RTC).
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/its-rtc[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/its-rtc[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/its-rtc/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/its-rtc/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[its-storyboard]]
|
[[its-storyboard]]
|
||||||
==== its-storyboard
|
==== its-storyboard
|
||||||
@ -454,9 +454,9 @@ Configuration]
|
|||||||
Plugin to integrate with Storyboard task tracking system.
|
Plugin to integrate with Storyboard task tracking system.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/its-storyboard[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/its-storyboard[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/its-storyboard/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/its-storyboard/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation]
|
Documentation,role=external,window=_blank]
|
||||||
|
|
||||||
[[javamelody]]
|
[[javamelody]]
|
||||||
=== javamelody
|
=== javamelody
|
||||||
@ -467,11 +467,11 @@ This plugin integrates JavaMelody in Gerrit in order to retrieve live
|
|||||||
instrumentation data from Gerrit.
|
instrumentation data from Gerrit.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/javamelody[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/javamelody[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/javamelody/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/javamelody/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
https://gerrit.googlesource.com/plugins/javamelody/+doc/master/src/main/resources/Documentation/config.md[
|
https://gerrit.googlesource.com/plugins/javamelody/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[labelui]]
|
[[labelui]]
|
||||||
=== labelui
|
=== labelui
|
||||||
@ -482,9 +482,9 @@ table control to render the labels/approvals on the change screen
|
|||||||
screen).
|
screen).
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/labelui[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/labelui[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/labelui/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/labelui/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation]
|
Documentation,role=external,window=_blank]
|
||||||
|
|
||||||
[[menuextender]]
|
[[menuextender]]
|
||||||
=== menuextender
|
=== menuextender
|
||||||
@ -493,11 +493,11 @@ The menuextender plugin allows Gerrit administrators to configure
|
|||||||
additional menu entries from the WebUI.
|
additional menu entries from the WebUI.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/menuextender[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/menuextender[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/menuextender/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/menuextender/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/menuextender/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/menuextender/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[metrics-reporter-elasticsearch]]
|
[[metrics-reporter-elasticsearch]]
|
||||||
=== metrics-reporter-elasticsearch
|
=== metrics-reporter-elasticsearch
|
||||||
@ -505,7 +505,7 @@ Configuration]
|
|||||||
This plugin reports Gerrit metrics to Elasticsearch.
|
This plugin reports Gerrit metrics to Elasticsearch.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/metrics-reporter-elasticsearch[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/metrics-reporter-elasticsearch[
|
||||||
Project].
|
Project,role=external,window=_blank].
|
||||||
|
|
||||||
[[metrics-reporter-graphite]]
|
[[metrics-reporter-graphite]]
|
||||||
=== metrics-reporter-graphite
|
=== metrics-reporter-graphite
|
||||||
@ -513,7 +513,7 @@ Project].
|
|||||||
This plugin reports Gerrit metrics to Graphite.
|
This plugin reports Gerrit metrics to Graphite.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/metrics-reporter-graphite[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/metrics-reporter-graphite[
|
||||||
Project].
|
Project,role=external,window=_blank].
|
||||||
|
|
||||||
[[metrics-reporter-jmx]]
|
[[metrics-reporter-jmx]]
|
||||||
=== metrics-reporter-jmx
|
=== metrics-reporter-jmx
|
||||||
@ -521,7 +521,7 @@ Project].
|
|||||||
This plugin reports Gerrit metrics to JMX.
|
This plugin reports Gerrit metrics to JMX.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/metrics-reporter-jmx[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/metrics-reporter-jmx[
|
||||||
Project].
|
Project,role=external,window=_blank].
|
||||||
|
|
||||||
[[metrics-reporter-prometheus]]
|
[[metrics-reporter-prometheus]]
|
||||||
=== metrics-reporter-prometheus
|
=== metrics-reporter-prometheus
|
||||||
@ -529,7 +529,7 @@ Project].
|
|||||||
This plugin exposes Gerrit metrics for consumption by Prometheus.
|
This plugin exposes Gerrit metrics for consumption by Prometheus.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/metrics-reporter-prometheus[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/metrics-reporter-prometheus[
|
||||||
Project].
|
Project,role=external,window=_blank].
|
||||||
|
|
||||||
[[motd]]
|
[[motd]]
|
||||||
=== motd
|
=== motd
|
||||||
@ -541,11 +541,11 @@ the user (usually prefixed by “remote: ”), but will be silently
|
|||||||
discarded otherwise.
|
discarded otherwise.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/motd[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/motd[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/motd/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/motd/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/motd/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/motd/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[oauth-authentication-provider]]
|
[[oauth-authentication-provider]]
|
||||||
=== OAuth authentication provider
|
=== OAuth authentication provider
|
||||||
@ -563,16 +563,16 @@ Several OAuth2 providers are supported:
|
|||||||
* Keycloak
|
* Keycloak
|
||||||
* Office365
|
* Office365
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/oauth[Project] |
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/oauth[Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/oauth/+doc/master/src/main/resources/Documentation/config.md[Configuration]
|
link:https://gerrit.googlesource.com/plugins/oauth/+doc/master/src/main/resources/Documentation/config.md[Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[owners]]
|
[[owners]]
|
||||||
=== owners
|
=== owners
|
||||||
This plugin provides a Prolog predicate `add_owner_approval/3` that
|
This plugin provides a Prolog predicate `add_owner_approval/3` that
|
||||||
appends `label('Owner-Approval', need(_))` to a provided list.
|
appends `label('Owner-Approval', need(_))` to a provided list.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/owners[Project] |
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/owners[Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/owners/+doc/master/README.md[Documentation]
|
link:https://gerrit.googlesource.com/plugins/owners/+doc/master/README.md[Documentation,role=external,window=_blank]
|
||||||
|
|
||||||
[[project-download-commands]]
|
[[project-download-commands]]
|
||||||
=== project-download-commands
|
=== project-download-commands
|
||||||
@ -584,11 +584,11 @@ are inherited by the child projects. Child projects can overwrite the
|
|||||||
inherited download command or remove it by assigning no value to it.
|
inherited download command or remove it by assigning no value to it.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/project-download-commands[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/project-download-commands[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/project-download-commands/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/project-download-commands/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/project-download-commands/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/project-download-commands/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[quota]]
|
[[quota]]
|
||||||
=== quota
|
=== quota
|
||||||
@ -600,21 +600,21 @@ that a project or group can consume. To do this a Gerrit administrator
|
|||||||
can use this plugin to define quotas on project namespaces.
|
can use this plugin to define quotas on project namespaces.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/quota[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/quota[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/quota/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/quota/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation]
|
Documentation,role=external,window=_blank]
|
||||||
link:https://gerrit.googlesource.com/plugins/quota/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/quota/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[rabbitmq]]
|
[[rabbitmq]]
|
||||||
=== rabbitmq
|
=== rabbitmq
|
||||||
|
|
||||||
A plugin that publishes Gerrit events to a
|
A plugin that publishes Gerrit events to a
|
||||||
link:https://www.rabbitmq.com/[RabbitMQ] exchange.
|
link:https://www.rabbitmq.com/[RabbitMQ,role=external,window=_blank] exchange.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/rabbitmq[Project]
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/rabbitmq[Project,role=external,window=_blank]
|
||||||
link:https://gerrit.googlesource.com/plugins/rabbitmq/+/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/rabbitmq/+/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[readonly]]
|
[[readonly]]
|
||||||
=== readonly
|
=== readonly
|
||||||
@ -623,11 +623,11 @@ A plugin that makes the Gerrit server read-only by rejecting git pushes,
|
|||||||
blocking HTTP PUT/POST/DELETE requests, and disabling SSH commands.
|
blocking HTTP PUT/POST/DELETE requests, and disabling SSH commands.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/readonly[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/readonly[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/readonly/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/readonly/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/readonly/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/readonly/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[ref-protection]]
|
[[ref-protection]]
|
||||||
=== ref-protection
|
=== ref-protection
|
||||||
@ -638,9 +638,9 @@ Backups of deleted or non-fast-forward updated refs are created under the
|
|||||||
`refs/backups/` namespace.
|
`refs/backups/` namespace.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/ref-protection[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/ref-protection[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/ref-protection/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/ref-protection/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation]
|
Documentation,role=external,window=_blank]
|
||||||
|
|
||||||
[[reparent]]
|
[[reparent]]
|
||||||
=== reparent
|
=== reparent
|
||||||
@ -648,11 +648,11 @@ Documentation]
|
|||||||
A plugin that provides project reparenting as a self-service for project owners.
|
A plugin that provides project reparenting as a self-service for project owners.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/reparent[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/reparent[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/reparent/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/reparent/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/reparent/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/reparent/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[review-strategy]]
|
[[review-strategy]]
|
||||||
=== review-strategy
|
=== review-strategy
|
||||||
@ -660,9 +660,9 @@ Configuration]
|
|||||||
This plugin allows users to configure different review strategies.
|
This plugin allows users to configure different review strategies.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/review-strategy[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/review-strategy[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/review-strategy/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/review-strategy/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation]
|
Documentation,role=external,window=_blank]
|
||||||
|
|
||||||
[[reviewers]]
|
[[reviewers]]
|
||||||
=== reviewers
|
=== reviewers
|
||||||
@ -670,11 +670,11 @@ Documentation]
|
|||||||
A plugin that allows adding default reviewers to a change.
|
A plugin that allows adding default reviewers to a change.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/reviewers[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/reviewers[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/reviewers/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/reviewers/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/reviewers/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/reviewers/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[reviewers-by-blame]]
|
[[reviewers-by-blame]]
|
||||||
=== reviewers-by-blame
|
=== reviewers-by-blame
|
||||||
@ -686,11 +686,11 @@ users should be familiar with the code and can mostly review the
|
|||||||
change.
|
change.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/reviewers-by-blame[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/reviewers-by-blame[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/reviewers-by-blame/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/reviewers-by-blame/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/reviewers-by-blame/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/reviewers-by-blame/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[groovy-provider]]
|
[[groovy-provider]]
|
||||||
=== scripting/groovy-provider
|
=== scripting/groovy-provider
|
||||||
@ -698,16 +698,16 @@ Configuration]
|
|||||||
This plugin provides a Groovy runtime environment for Gerrit plugins in Groovy.
|
This plugin provides a Groovy runtime environment for Gerrit plugins in Groovy.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/scripting/groovy-provider[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/scripting/groovy-provider[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/scripting/groovy-provider/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/scripting/groovy-provider/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation]
|
Documentation,role=external,window=_blank]
|
||||||
|
|
||||||
[[saml-authentication-provider]]
|
[[saml-authentication-provider]]
|
||||||
=== SAML2 authentication provider
|
=== SAML2 authentication provider
|
||||||
|
|
||||||
This plugin enables Gerrit to use SAML2 protocol for authentication.
|
This plugin enables Gerrit to use SAML2 protocol for authentication.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/saml[Project]
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/saml[Project,role=external,window=_blank]
|
||||||
|
|
||||||
[[scala-provider]]
|
[[scala-provider]]
|
||||||
=== scripting/scala-provider
|
=== scripting/scala-provider
|
||||||
@ -715,9 +715,9 @@ link:https://gerrit-review.googlesource.com/admin/repos/plugins/saml[Project]
|
|||||||
This plugin provides a Scala runtime environment for Gerrit plugins in Scala.
|
This plugin provides a Scala runtime environment for Gerrit plugins in Scala.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/scripting/scala-provider[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/scripting/scala-provider[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/scripting/scala-provider/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/scripting/scala-provider/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation]
|
Documentation,role=external,window=_blank]
|
||||||
|
|
||||||
[[scripts]]
|
[[scripts]]
|
||||||
=== scripts
|
=== scripts
|
||||||
@ -728,8 +728,8 @@ to provide simple and useful extensions.
|
|||||||
Groovy and Scala scripts require the installation of the corresponding
|
Groovy and Scala scripts require the installation of the corresponding
|
||||||
scripting/*-provider plugin in order to be loaded into Gerrit.
|
scripting/*-provider plugin in order to be loaded into Gerrit.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/scripts[Project]
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/scripts[Project,role=external,window=_blank]
|
||||||
link:https://gerrit.googlesource.com/plugins/scripts/+doc/master/README.md[Documentation]
|
link:https://gerrit.googlesource.com/plugins/scripts/+doc/master/README.md[Documentation,role=external,window=_blank]
|
||||||
|
|
||||||
[[server-config]]
|
[[server-config]]
|
||||||
=== server-config
|
=== server-config
|
||||||
@ -741,7 +741,7 @@ where Gerrit's config files are stored is difficult or impossible to
|
|||||||
get.
|
get.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/server-config[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/server-config[
|
||||||
Project]
|
Project,role=external,window=_blank]
|
||||||
|
|
||||||
[[serviceuser]]
|
[[serviceuser]]
|
||||||
=== serviceuser
|
=== serviceuser
|
||||||
@ -754,11 +754,11 @@ Plugin in Jenkins. A service user is not able to login into the Gerrit
|
|||||||
WebUI and it cannot push commits or tags.
|
WebUI and it cannot push commits or tags.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/serviceuser[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/serviceuser[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/serviceuser/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/serviceuser/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/serviceuser/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/serviceuser/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[uploadvalidator]]
|
[[uploadvalidator]]
|
||||||
=== uploadvalidator
|
=== uploadvalidator
|
||||||
@ -770,11 +770,11 @@ and a maximum allowed path length. Pushes of commits that violate these
|
|||||||
settings are rejected by Gerrit.
|
settings are rejected by Gerrit.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/uploadvalidator[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/uploadvalidator[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/uploadvalidator/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/uploadvalidator/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/uploadvalidator/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/uploadvalidator/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[verify-status]]
|
[[verify-status]]
|
||||||
=== verify-status
|
=== verify-status
|
||||||
@ -784,11 +784,11 @@ view them on the Gerrit UI. The metadata can be stored in the Gerrit database
|
|||||||
or in a completely separate datastore.
|
or in a completely separate datastore.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/verify-status[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/verify-status[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/verify-status/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/verify-status/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/verify-status/+doc/master/src/main/resources/Documentation/database.md[
|
link:https://gerrit.googlesource.com/plugins/verify-status/+doc/master/src/main/resources/Documentation/database.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[websession-flatfile]]
|
[[websession-flatfile]]
|
||||||
=== websession-flatfile
|
=== websession-flatfile
|
||||||
@ -799,11 +799,11 @@ among multiple Gerrit servers, making it useful for multi-master
|
|||||||
Gerrit installations.
|
Gerrit installations.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/websession-flatfile[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/websession-flatfile[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/websession-flatfile/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/websession-flatfile/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/websession-flatfile/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/websession-flatfile/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
[[x-docs]]
|
[[x-docs]]
|
||||||
=== x-docs
|
=== x-docs
|
||||||
@ -811,11 +811,11 @@ Configuration]
|
|||||||
This plugin serves project documentation as HTML pages.
|
This plugin serves project documentation as HTML pages.
|
||||||
|
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/x-docs[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/x-docs[
|
||||||
Project] |
|
Project,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/x-docs/+doc/master/src/main/resources/Documentation/about.md[
|
link:https://gerrit.googlesource.com/plugins/x-docs/+doc/master/src/main/resources/Documentation/about.md[
|
||||||
Documentation] |
|
Documentation,role=external,window=_blank] |
|
||||||
link:https://gerrit.googlesource.com/plugins/x-docs/+doc/master/src/main/resources/Documentation/config.md[
|
link:https://gerrit.googlesource.com/plugins/x-docs/+doc/master/src/main/resources/Documentation/config.md[
|
||||||
Configuration]
|
Configuration,role=external,window=_blank]
|
||||||
|
|
||||||
|
|
||||||
GERRIT
|
GERRIT
|
||||||
|
@ -17,7 +17,7 @@ setting should be `OpenID`:
|
|||||||
As this is the default setting there is nothing required from the
|
As this is the default setting there is nothing required from the
|
||||||
site administrator to make use of the OpenID authentication services.
|
site administrator to make use of the OpenID authentication services.
|
||||||
|
|
||||||
* http://openid.net/[openid.net]
|
* http://openid.net/[openid.net,,role=external,window=_blank]
|
||||||
|
|
||||||
If Jetty is being used, you may need to increase the header
|
If Jetty is being used, you may need to increase the header
|
||||||
buffer size parameter, due to very long header lines.
|
buffer size parameter, due to very long header lines.
|
||||||
@ -34,7 +34,7 @@ must only have OpenIDs which match at least one pattern from the
|
|||||||
`auth.trustedOpenID` list in `gerrit.config`. Patterns may be
|
`auth.trustedOpenID` list in `gerrit.config`. Patterns may be
|
||||||
either a
|
either a
|
||||||
link:http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html[standard
|
link:http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html[standard
|
||||||
Java regular expression (java.util.regex)] (must start with `^`
|
Java regular expression (java.util.regex),,role=external,window=_blank] (must start with `^`
|
||||||
and end with `$`) or be a simple prefix (any other string).
|
and end with `$`) or be a simple prefix (any other string).
|
||||||
|
|
||||||
Out of the box Gerrit is configured to trust two patterns, which
|
Out of the box Gerrit is configured to trust two patterns, which
|
||||||
@ -65,12 +65,12 @@ with that identity. Doing so will result in a new account being created, and
|
|||||||
subsequent attempts to link that account with the existing account will fail.
|
subsequent attempts to link that account with the existing account will fail.
|
||||||
In cases where this happens, the administrator will need to manually merge the
|
In cases where this happens, the administrator will need to manually merge the
|
||||||
accounts. See link:https://gerrit.googlesource.com/homepage/+/md-pages/docs/SqlMergeUserAccounts.md[
|
accounts. See link:https://gerrit.googlesource.com/homepage/+/md-pages/docs/SqlMergeUserAccounts.md[
|
||||||
Merging Gerrit User Accounts] on the Gerrit Wiki for details.
|
Merging Gerrit User Accounts,,role=external,window=_blank] on the Gerrit Wiki for details.
|
||||||
|
|
||||||
Linking another identity is also useful for users whose primary OpenID provider
|
Linking another identity is also useful for users whose primary OpenID provider
|
||||||
shuts down. For example Google
|
shuts down. For example Google
|
||||||
link:https://developers.google.com/+/api/auth-migration[shut down their OpenID
|
link:https://developers.google.com/+/api/auth-migration[shut down their OpenID
|
||||||
service on 20th April 2015]. Users who failed to add an alternative identity with
|
service on 20th April 2015,,role=external,window=_blank]. Users who failed to add an alternative identity with
|
||||||
another OpenID provider before that date will end up with their account only having
|
another OpenID provider before that date will end up with their account only having
|
||||||
a disabled Google identity. After creating a separate account with an alternative
|
a disabled Google identity. After creating a separate account with an alternative
|
||||||
provider, they will need to ask the administrator to merge the accounts using the
|
provider, they will need to ask the administrator to merge the accounts using the
|
||||||
|
@ -8,10 +8,10 @@ To build Gerrit from source, you need:
|
|||||||
* A Linux or macOS system (Windows is not supported at this time)
|
* A Linux or macOS system (Windows is not supported at this time)
|
||||||
* A JDK for Java 8|9|10|11|...
|
* A JDK for Java 8|9|10|11|...
|
||||||
* Python 2 or 3
|
* Python 2 or 3
|
||||||
* link:https://github.com/nodesource/distributions/blob/master/README.md[Node.js (including npm)]
|
* link:https://github.com/nodesource/distributions/blob/master/README.md[Node.js (including npm),role=external,window=_blank]
|
||||||
* Bower (`sudo npm install -g bower`)
|
* Bower (`sudo npm install -g bower`)
|
||||||
* link:https://docs.bazel.build/versions/master/install.html[Bazel] directly
|
* link:https://docs.bazel.build/versions/master/install.html[Bazel,role=external,window=_blank] directly
|
||||||
or through link:https://github.com/bazelbuild/bazelisk[Bazelisk]
|
or through link:https://github.com/bazelbuild/bazelisk[Bazelisk,role=external,window=_blank]
|
||||||
* Maven
|
* Maven
|
||||||
* zip, unzip
|
* zip, unzip
|
||||||
* gcc
|
* gcc
|
||||||
@ -36,7 +36,7 @@ To check the installed version of Java, open a terminal window and run:
|
|||||||
==== Java 13 support
|
==== Java 13 support
|
||||||
|
|
||||||
Java 13 (and newer) is supported through vanilla java toolchain
|
Java 13 (and newer) is supported through vanilla java toolchain
|
||||||
link:https://docs.bazel.build/versions/master/toolchains.html[Bazel option].
|
link:https://docs.bazel.build/versions/master/toolchains.html[Bazel option,role=external,window=_blank].
|
||||||
To build Gerrit with Java 13 and newer, specify vanilla java toolchain and
|
To build Gerrit with Java 13 and newer, specify vanilla java toolchain and
|
||||||
provide the path to JDK home:
|
provide the path to JDK home:
|
||||||
|
|
||||||
@ -96,7 +96,7 @@ To build Gerrit with Java 11, specify JDK 11 java toolchain:
|
|||||||
```
|
```
|
||||||
|
|
||||||
=== Node.js and npm packages
|
=== Node.js and npm packages
|
||||||
See link:https://gerrit.googlesource.com/gerrit/+/master/polygerrit-ui/README.md#installing-node_js-and-npm-packages[Installing Node.js and npm packages].
|
See link:https://gerrit.googlesource.com/gerrit/+/master/polygerrit-ui/README.md#installing-node_js-and-npm-packages[Installing Node.js and npm packages,role=external,window=_blank].
|
||||||
|
|
||||||
[[build]]
|
[[build]]
|
||||||
== Building on the Command Line
|
== Building on the Command Line
|
||||||
@ -212,7 +212,7 @@ is not regenerated.
|
|||||||
|
|
||||||
=== IntelliJ
|
=== IntelliJ
|
||||||
|
|
||||||
The Gerrit build works with Bazel's link:https://ij.bazel.build[IntelliJ plugin].
|
The Gerrit build works with Bazel's link:https://ij.bazel.build[IntelliJ plugin,role=external,window=_blank].
|
||||||
Please follow the instructions on <<dev-intellij#,IntelliJ Setup>>.
|
Please follow the instructions on <<dev-intellij#,IntelliJ Setup>>.
|
||||||
|
|
||||||
=== Eclipse
|
=== Eclipse
|
||||||
@ -232,7 +232,7 @@ and then follow the link:dev-eclipse.html#setup[setup instructions].
|
|||||||
If an updated classpath is needed, the Eclipse project can be
|
If an updated classpath is needed, the Eclipse project can be
|
||||||
refreshed and missing dependency JARs can be downloaded by running
|
refreshed and missing dependency JARs can be downloaded by running
|
||||||
`project.py` again. For IntelliJ, you need to click the `Sync Project
|
`project.py` again. For IntelliJ, you need to click the `Sync Project
|
||||||
with BUILD Files` button of link:https://ij.bazel.build[Bazel plugin].
|
with BUILD Files` button of link:https://ij.bazel.build[Bazel plugin,role=external,window=_blank].
|
||||||
|
|
||||||
[[documentation]]
|
[[documentation]]
|
||||||
=== Documentation
|
=== Documentation
|
||||||
@ -342,11 +342,11 @@ The following values are currently supported for the group name:
|
|||||||
|
|
||||||
Successfully running the Elasticsearch tests requires Docker, and
|
Successfully running the Elasticsearch tests requires Docker, and
|
||||||
may require setting the local
|
may require setting the local
|
||||||
link:https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html[virtual memory].
|
link:https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html[virtual memory,role=external,window=_blank].
|
||||||
|
|
||||||
If Docker is not available, the Elasticsearch tests will be skipped.
|
If Docker is not available, the Elasticsearch tests will be skipped.
|
||||||
Note that Bazel currently does not show
|
Note that Bazel currently does not show
|
||||||
link:https://github.com/bazelbuild/bazel/issues/3476[the skipped tests].
|
link:https://github.com/bazelbuild/bazel/issues/3476[the skipped tests,role=external,window=_blank].
|
||||||
|
|
||||||
== Dependencies
|
== Dependencies
|
||||||
|
|
||||||
@ -459,7 +459,7 @@ To accelerate builds, several caches are activated per default:
|
|||||||
* ~/.gerritcodereview/bazel-cache/cas
|
* ~/.gerritcodereview/bazel-cache/cas
|
||||||
|
|
||||||
Currently none of these caches have a maximum size limit. See
|
Currently none of these caches have a maximum size limit. See
|
||||||
link:https://github.com/bazelbuild/bazel/issues/5139[this bazel issue] for
|
link:https://github.com/bazelbuild/bazel/issues/5139[this bazel issue,role=external,window=_blank] for
|
||||||
details. Users should watch the cache sizes and clean them manually if
|
details. Users should watch the cache sizes and clean them manually if
|
||||||
necessary.
|
necessary.
|
||||||
|
|
||||||
@ -470,7 +470,7 @@ Parts of the PolyGerrit build require running NPM-based JavaScript programs as
|
|||||||
"binaries". We don't attempt to resolve and download NPM dependencies at build
|
"binaries". We don't attempt to resolve and download NPM dependencies at build
|
||||||
time, but instead use pre-built bundles of the NPM binary along with all its
|
time, but instead use pre-built bundles of the NPM binary along with all its
|
||||||
dependencies. Some packages on
|
dependencies. Some packages on
|
||||||
link:https://docs.npmjs.com/misc/registry[registry.npmjs.org] come with their
|
link:https://docs.npmjs.com/misc/registry[registry.npmjs.org,role=external,window=_blank] come with their
|
||||||
dependencies bundled, but this is the exception rather than the rule. More
|
dependencies bundled, but this is the exception rather than the rule. More
|
||||||
commonly, to add a new binary to this list, you will need to bundle the binary
|
commonly, to add a new binary to this list, you will need to bundle the binary
|
||||||
yourself.
|
yourself.
|
||||||
@ -498,7 +498,7 @@ its transitive dependencies. We can only legally distribute a bundle via our
|
|||||||
storage bucket if the licenses allow us to do so. As long as all of the listed
|
storage bucket if the licenses allow us to do so. As long as all of the listed
|
||||||
license are allowed by
|
license are allowed by
|
||||||
link:https://opensource.google.com/docs/thirdparty/licenses/[Google's
|
link:https://opensource.google.com/docs/thirdparty/licenses/[Google's
|
||||||
standards]. Any `by_exception_only`, commercial, prohibited, or unlisted
|
standards,role=external,window=_blank]. Any `by_exception_only`, commercial, prohibited, or unlisted
|
||||||
licenses are not allowed; otherwise, it is ok to distribute the source. If in
|
licenses are not allowed; otherwise, it is ok to distribute the source. If in
|
||||||
doubt, contact a maintainer who is a Googler.
|
doubt, contact a maintainer who is a Googler.
|
||||||
|
|
||||||
@ -523,7 +523,7 @@ This creates a file named `$package-$version.tgz` in your working directory.
|
|||||||
|
|
||||||
Any project maintainer can upload this file to the
|
Any project maintainer can upload this file to the
|
||||||
link:https://console.cloud.google.com/storage/browser/gerrit-maven/npm-packages[storage
|
link:https://console.cloud.google.com/storage/browser/gerrit-maven/npm-packages[storage
|
||||||
bucket].
|
bucket,role=external,window=_blank].
|
||||||
|
|
||||||
Finally, add the new binary to the build process:
|
Finally, add the new binary to the build process:
|
||||||
----
|
----
|
||||||
|
@ -6,17 +6,17 @@ contributions are accepted. To view and accept the agreements do the
|
|||||||
following:
|
following:
|
||||||
|
|
||||||
. Click 'Sign In' at the top right corner of
|
. Click 'Sign In' at the top right corner of
|
||||||
https://gerrit-review.googlesource.com/
|
https://gerrit-review.googlesource.com/[role=external,window=_blank]
|
||||||
. Sign In with your Google account
|
. Sign In with your Google account
|
||||||
. After signing in, go to the
|
. After signing in, go to the
|
||||||
link:https://gerrit-review.googlesource.com/#/settings/agreements[Agreements]
|
link:https://gerrit-review.googlesource.com/#/settings/agreements[Agreements,role=external,window=_blank]
|
||||||
tab on the settings page
|
tab on the settings page
|
||||||
. Click on 'New Contributor Agreement' and follow the instructions
|
. Click on 'New Contributor Agreement' and follow the instructions
|
||||||
|
|
||||||
For reference, the actual agreements are linked below:
|
For reference, the actual agreements are linked below:
|
||||||
|
|
||||||
* link:https://cla.developers.google.com/about/google-individual[Individual Agreement]
|
* link:https://cla.developers.google.com/about/google-individual[Individual Agreement,role=external,window=_blank]
|
||||||
* link:https://cla.developers.google.com/about/google-corporate[Corporate Agreement]
|
* link:https://cla.developers.google.com/about/google-corporate[Corporate Agreement,role=external,window=_blank]
|
||||||
|
|
||||||
GERRIT
|
GERRIT
|
||||||
------
|
------
|
||||||
|
@ -1,19 +1,19 @@
|
|||||||
= Gerrit Community
|
= Gerrit Community
|
||||||
|
|
||||||
Gerrit is developed as a
|
Gerrit is developed as a
|
||||||
link:https://gerrit-review.googlesource.com/[self-hosting open source project]
|
link:https://gerrit-review.googlesource.com/[self-hosting open source project,role=external,window=_blank]
|
||||||
and very much welcomes contributions from anyone with a
|
and very much welcomes contributions from anyone with a
|
||||||
link:dev-cla.html[contributor's agreement] on file with the project.
|
link:dev-cla.html[contributor's agreement] on file with the project.
|
||||||
|
|
||||||
[[project-information]]
|
[[project-information]]
|
||||||
== Project Information
|
== Project Information
|
||||||
|
|
||||||
* link:https://www.gerritcodereview.com/[Project Homepage]
|
* link:https://www.gerritcodereview.com/[Project Homepage,role=external,window=_blank]
|
||||||
* link:https://www.gerritcodereview.com/codeofconduct.html[Code of Conduct]
|
* link:https://www.gerritcodereview.com/codeofconduct.html[Code of Conduct,role=external,window=_blank]
|
||||||
* link:https://www.gerritcodereview.com/releases-readme.html[Release Versions]
|
* link:https://www.gerritcodereview.com/releases-readme.html[Release Versions,role=external,window=_blank]
|
||||||
* link:https://gerrit.googlesource.com/gerrit[Source]
|
* link:https://gerrit.googlesource.com/gerrit[Source,role=external,window=_blank]
|
||||||
* link:https://bugs.chromium.org/p/gerrit/issues/list[Issue Tracking]
|
* link:https://bugs.chromium.org/p/gerrit/issues/list[Issue Tracking,role=external,window=_blank]
|
||||||
* link:https://gerrit-review.googlesource.com/q/status:open+project:gerrit[Change Review]
|
* link:https://gerrit-review.googlesource.com/q/status:open+project:gerrit[Change Review,role=external,window=_blank]
|
||||||
* link:dev-design.html[System Design]
|
* link:dev-design.html[System Design]
|
||||||
* Processes
|
* Processes
|
||||||
** link:dev-processes.html#project-governance[Project Governance / Engineering Steering Committee]
|
** link:dev-processes.html#project-governance[Project Governance / Engineering Steering Committee]
|
||||||
|
@ -33,7 +33,7 @@ link:dev-roles.html#maintainer[maintainers] can require to follow the
|
|||||||
design-driven contribution process instead.
|
design-driven contribution process instead.
|
||||||
|
|
||||||
If you are in doubt which process is right for you, consult the
|
If you are in doubt which process is right for you, consult the
|
||||||
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss]
|
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss,role=external,window=_blank]
|
||||||
mailing list.
|
mailing list.
|
||||||
|
|
||||||
These contribution processes apply to everyone who contributes code to
|
These contribution processes apply to everyone who contributes code to
|
||||||
@ -83,11 +83,11 @@ As Gerrit is a code review tool, naturally contributions will
|
|||||||
be reviewed before they will get submitted to the code base. To
|
be reviewed before they will get submitted to the code base. To
|
||||||
start your contribution, please make a git commit and upload it
|
start your contribution, please make a git commit and upload it
|
||||||
for review to the link:https://gerrit-review.googlesource.com/[
|
for review to the link:https://gerrit-review.googlesource.com/[
|
||||||
gerrit-review.googlesource.com] Gerrit server. To help speed up the
|
gerrit-review.googlesource.com,role=external,window=_blank] Gerrit server. To help speed up the
|
||||||
review of your change, review these link:dev-crafting-changes.html[
|
review of your change, review these link:dev-crafting-changes.html[
|
||||||
guidelines] before submitting your change. You can view the pending
|
guidelines] before submitting your change. You can view the pending
|
||||||
Gerrit contributions and their statuses
|
Gerrit contributions and their statuses
|
||||||
link:https://gerrit-review.googlesource.com/#/q/status:open+project:gerrit[here].
|
link:https://gerrit-review.googlesource.com/#/q/status:open+project:gerrit[here,role=external,window=_blank].
|
||||||
|
|
||||||
Depending on the size of that list it might take a while for
|
Depending on the size of that list it might take a while for
|
||||||
your change to get reviewed. Naturally there are fewer
|
your change to get reviewed. Naturally there are fewer
|
||||||
|
@ -9,7 +9,7 @@ installed without downloading any additional files.
|
|||||||
|
|
||||||
To make working with core plugins easy, they are linked as
|
To make working with core plugins easy, they are linked as
|
||||||
link:https://gerrit.googlesource.com/gerrit/+/refs/heads/master/.gitmodules[Git
|
link:https://gerrit.googlesource.com/gerrit/+/refs/heads/master/.gitmodules[Git
|
||||||
submodules] in the `gerrit` repository. E.g. this means they can be easily
|
submodules,role=external,window=_blank] in the `gerrit` repository. E.g. this means they can be easily
|
||||||
link:dev-readme.html#clone[cloned] together with Gerrit.
|
link:dev-readme.html#clone[cloned] together with Gerrit.
|
||||||
|
|
||||||
All core plugins are developed and maintained by the
|
All core plugins are developed and maintained by the
|
||||||
@ -35,12 +35,12 @@ criteria:
|
|||||||
1. License:
|
1. License:
|
||||||
+
|
+
|
||||||
The plugin code is available under the
|
The plugin code is available under the
|
||||||
link:http://www.apache.org/licenses/LICENSE-2.0[Apache License Version 2.0].
|
link:http://www.apache.org/licenses/LICENSE-2.0[Apache License Version 2.0,role=external,window=_blank].
|
||||||
|
|
||||||
2. Hosting:
|
2. Hosting:
|
||||||
+
|
+
|
||||||
The plugin development is hosted on the
|
The plugin development is hosted on the
|
||||||
link:https://gerrit-review.googlesource.com[gerrit-review] Gerrit Server.
|
link:https://gerrit-review.googlesource.com[gerrit-review,role=external,window=_blank] Gerrit Server.
|
||||||
|
|
||||||
3. Scope:
|
3. Scope:
|
||||||
+
|
+
|
||||||
|
@ -86,10 +86,10 @@ To set up git's remote for easy pushing, run the following:
|
|||||||
The HTTPS access requires proper username and password; this can be obtained
|
The HTTPS access requires proper username and password; this can be obtained
|
||||||
by clicking the 'Obtain Password' link on the
|
by clicking the 'Obtain Password' link on the
|
||||||
link:https://gerrit-review.googlesource.com/#/settings/http-password[HTTP
|
link:https://gerrit-review.googlesource.com/#/settings/http-password[HTTP
|
||||||
Password tab of the user settings page].
|
Password tab of the user settings page,role=external,window=_blank].
|
||||||
|
|
||||||
Alternately, you may use the
|
Alternately, you may use the
|
||||||
link:https://pypi.org/project/git-review/[git-review] tool to submit changes
|
link:https://pypi.org/project/git-review/[git-review,role=external,window=_blank] tool to submit changes
|
||||||
to Gerrit. If you do, it will set up the Change-Id hook and `gerrit` remote
|
to Gerrit. If you do, it will set up the Change-Id hook and `gerrit` remote
|
||||||
for you. You will still need to do the HTTP access step.
|
for you. You will still need to do the HTTP access step.
|
||||||
|
|
||||||
@ -109,12 +109,12 @@ extend gerrit CI to take care of this, but it's not yet implemented.
|
|||||||
|
|
||||||
Gerrit generally follows the
|
Gerrit generally follows the
|
||||||
link:https://google.github.io/styleguide/javaguide.html[Google Java Style
|
link:https://google.github.io/styleguide/javaguide.html[Google Java Style
|
||||||
Guide].
|
Guide,role=external,window=_blank].
|
||||||
|
|
||||||
To format Java source code, Gerrit uses the
|
To format Java source code, Gerrit uses the
|
||||||
link:https://github.com/google/google-java-format[`google-java-format`]
|
link:https://github.com/google/google-java-format[`google-java-format`,role=external,window=_blank]
|
||||||
tool (version 1.7), and to format Bazel BUILD, WORKSPACE and .bzl files the
|
tool (version 1.7), and to format Bazel BUILD, WORKSPACE and .bzl files the
|
||||||
link:https://github.com/bazelbuild/buildtools/tree/master/buildifier[`buildifier`]
|
link:https://github.com/bazelbuild/buildtools/tree/master/buildifier[`buildifier`,role=external,window=_blank]
|
||||||
tool (version 0.29.0).
|
tool (version 0.29.0).
|
||||||
These tools automatically apply format according to the style guides; this
|
These tools automatically apply format according to the style guides; this
|
||||||
streamlines code review by reducing the need for time-consuming, tedious,
|
streamlines code review by reducing the need for time-consuming, tedious,
|
||||||
|
@ -72,7 +72,7 @@ It is expected that:
|
|||||||
|
|
||||||
To propose a new design, upload a change to the
|
To propose a new design, upload a change to the
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/homepage[
|
link:https://gerrit-review.googlesource.com/admin/repos/homepage[
|
||||||
homepage] repository that adds a new folder under `pages/design-docs/`
|
homepage,role=external,window=_blank] repository that adds a new folder under `pages/design-docs/`
|
||||||
which contains at least an `index.md` and a `uses-cases.md` file (see
|
which contains at least an `index.md` and a `uses-cases.md` file (see
|
||||||
link:#structure[design doc structure] above).
|
link:#structure[design doc structure] above).
|
||||||
|
|
||||||
@ -87,7 +87,7 @@ to do it (which is not guaranteed to happen).
|
|||||||
|
|
||||||
Only very few maintainers actively watch out for uploaded design docs.
|
Only very few maintainers actively watch out for uploaded design docs.
|
||||||
To raise awareness you may want to send a notification to the
|
To raise awareness you may want to send a notification to the
|
||||||
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss]
|
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss,role=external,window=_blank]
|
||||||
mailing list about your uploaded design doc. But the discussion should
|
mailing list about your uploaded design doc. But the discussion should
|
||||||
not take place on the mailing list, comments should be made by reviewing
|
not take place on the mailing list, comments should be made by reviewing
|
||||||
the change in Gerrit.
|
the change in Gerrit.
|
||||||
@ -122,7 +122,7 @@ scope of the project and if it can be accepted.
|
|||||||
|
|
||||||
. Go to the
|
. Go to the
|
||||||
link:https://gerrit-review.googlesource.com/settings/#Notifications[
|
link:https://gerrit-review.googlesource.com/settings/#Notifications[
|
||||||
notification settings]
|
notification settings,role=external,window=_blank]
|
||||||
. Add a project watch for the `homepage` repository with the following
|
. Add a project watch for the `homepage` repository with the following
|
||||||
query: `dir:pages/design-docs`
|
query: `dir:pages/design-docs`
|
||||||
|
|
||||||
|
@ -68,10 +68,10 @@ on a J2EE servlet container and an SQL database.
|
|||||||
Since Gerrit 3.x link:note-db.html[NoteDb] replaced the SQL database
|
Since Gerrit 3.x link:note-db.html[NoteDb] replaced the SQL database
|
||||||
and all metadata is now stored in Git.
|
and all metadata is now stored in Git.
|
||||||
|
|
||||||
* link:http://video.google.com/videoplay?docid=-8502904076440714866[Mondrian Code Review On The Web]
|
* link:http://video.google.com/videoplay?docid=-8502904076440714866[Mondrian Code Review On The Web,role=external,window=_blank]
|
||||||
* link:https://github.com/rietveld-codereview/rietveld[Rietveld - Code Review for Subversion]
|
* link:https://github.com/rietveld-codereview/rietveld[Rietveld - Code Review for Subversion,role=external,window=_blank]
|
||||||
* link:http://eagain.net/gitweb/?p=gitosis.git;a=blob;f=README.rst;hb=HEAD[Gitosis README]
|
* link:http://eagain.net/gitweb/?p=gitosis.git;a=blob;f=README.rst;hb=HEAD[Gitosis README,role=external,window=_blank]
|
||||||
* link:http://source.android.com/[Android Open Source Project]
|
* link:http://source.android.com/[Android Open Source Project,role=external,window=_blank]
|
||||||
|
|
||||||
|
|
||||||
== Overview
|
== Overview
|
||||||
@ -167,8 +167,8 @@ User authentication is handled by OpenID, and therefore Gerrit
|
|||||||
requires that the OpenID provider selected by a user must be
|
requires that the OpenID provider selected by a user must be
|
||||||
online and operating in order to authenticate that user.
|
online and operating in order to authenticate that user.
|
||||||
|
|
||||||
* link:http://www.kernel.org/pub/software/scm/git/docs/gitrepository-layout.html[Git Repository Format]
|
* link:http://www.kernel.org/pub/software/scm/git/docs/gitrepository-layout.html[Git Repository Format,role=external,window=_blank]
|
||||||
* link:http://openid.net/developers/specs/[OpenID Specifications]
|
* link:http://openid.net/developers/specs/[OpenID Specifications,role=external,window=_blank]
|
||||||
|
|
||||||
*1 Although an effort is underway to eliminate the use of the
|
*1 Although an effort is underway to eliminate the use of the
|
||||||
database altogether, and to store all the metadata directly in
|
database altogether, and to store all the metadata directly in
|
||||||
|
@ -8,9 +8,9 @@ under different load profiles.
|
|||||||
== What is Gatling?
|
== What is Gatling?
|
||||||
|
|
||||||
Gatling is a load testing tool which provides out of the box support for the HTTP protocol. Documentation on how to write an
|
Gatling is a load testing tool which provides out of the box support for the HTTP protocol. Documentation on how to write an
|
||||||
HTTP load test can be found link:https://gatling.io/docs/current/http/http_protocol/[`here`].
|
HTTP load test can be found link:https://gatling.io/docs/current/http/http_protocol/[`here`,role=external,window=_blank].
|
||||||
|
|
||||||
However, in the scenario we are proposing, we are leveraging the link:https://github.com/GerritForge/gatling-git[`Gatling Git extension`]
|
However, in the scenario we are proposing, we are leveraging the link:https://github.com/GerritForge/gatling-git[`Gatling Git extension`,role=external,window=_blank]
|
||||||
to run tests at Git protocol level.
|
to run tests at Git protocol level.
|
||||||
|
|
||||||
Gatling is written in Scala, but the abstraction provided by the Gatling DSL makes the scenarios implementation easy even without any Scala knowledge.
|
Gatling is written in Scala, but the abstraction provided by the Gatling DSL makes the scenarios implementation easy even without any Scala knowledge.
|
||||||
@ -32,7 +32,7 @@ sbt compile
|
|||||||
==== Setup
|
==== Setup
|
||||||
|
|
||||||
If you are running SSH commands the private keys of the users used for testing need to go in `/tmp/ssh-keys`.
|
If you are running SSH commands the private keys of the users used for testing need to go in `/tmp/ssh-keys`.
|
||||||
The keys need to be generated this way (JSch won't validate them [otherwise](https://stackoverflow.com/questions/53134212/invalid-privatekey-when-using-jsch):
|
The keys need to be generated this way (JSch won't validate them [otherwise,role=external,window=_blank](https://stackoverflow.com/questions/53134212/invalid-privatekey-when-using-jsch):
|
||||||
|
|
||||||
----
|
----
|
||||||
ssh-keygen -m PEM -t rsa -C "test@mail.com" -f /tmp/ssh-keys/id_rsa
|
ssh-keygen -m PEM -t rsa -C "test@mail.com" -f /tmp/ssh-keys/id_rsa
|
||||||
|
@ -8,7 +8,7 @@ Java 8 or later SDK is require
|
|||||||
[[setup]]
|
[[setup]]
|
||||||
== Project Setup
|
== Project Setup
|
||||||
|
|
||||||
In your Eclipse installation's link:https://wiki.eclipse.org/Eclipse.ini[`eclipse.ini`] file,
|
In your Eclipse installation's link:https://wiki.eclipse.org/Eclipse.ini[`eclipse.ini`,role=external,window=_blank] file,
|
||||||
add the following line in the `vmargs` section:
|
add the following line in the `vmargs` section:
|
||||||
|
|
||||||
----
|
----
|
||||||
@ -60,13 +60,13 @@ Java 8 is still the default:
|
|||||||
== Code Formatter Settings
|
== Code Formatter Settings
|
||||||
|
|
||||||
To format source code, Gerrit uses the
|
To format source code, Gerrit uses the
|
||||||
link:https://github.com/google/google-java-format[`google-java-format`]
|
link:https://github.com/google/google-java-format[`google-java-format`,role=external,window=_blank]
|
||||||
tool (version 1.7), which automatically formats code to follow the
|
tool (version 1.7), which automatically formats code to follow the
|
||||||
style guide. See link:dev-crafting-changes.html#style[Code Style] for the
|
style guide. See link:dev-crafting-changes.html#style[Code Style] for the
|
||||||
instruction how to set up command line tool that uses this formatter.
|
instruction how to set up command line tool that uses this formatter.
|
||||||
The Eclipse plugin is provided that allows to format with the same
|
The Eclipse plugin is provided that allows to format with the same
|
||||||
formatter from within the Eclipse IDE. See
|
formatter from within the Eclipse IDE. See
|
||||||
link:https://github.com/google/google-java-format#eclipse[Eclipse plugin]
|
link:https://github.com/google/google-java-format#eclipse[Eclipse plugin,role=external,window=_blank]
|
||||||
for details how to install it. It's important to use the same plugin version
|
for details how to install it. It's important to use the same plugin version
|
||||||
as the `google-java-format` script.
|
as the `google-java-format` script.
|
||||||
|
|
||||||
|
@ -33,7 +33,7 @@ and/or destroy the data.
|
|||||||
|
|
||||||
Gerrit Inspector requires Jython library ('jython.jar') to be installed
|
Gerrit Inspector requires Jython library ('jython.jar') to be installed
|
||||||
in the '$site_path/lib' directory. Jython, a Python interpreter for
|
in the '$site_path/lib' directory. Jython, a Python interpreter for
|
||||||
the Java Virtual Machine, can be obtained from the http://www.jython.org/
|
the Java Virtual Machine, can be obtained from the http://www.jython.org/[role=external,window=_blank]
|
||||||
website. Only 'jython.jar' file is needed, installation of Jython libraries
|
website. Only 'jython.jar' file is needed, installation of Jython libraries
|
||||||
is optional. Gerrit Inspector has been tested with Jython 2.5.2 but
|
is optional. Gerrit Inspector has been tested with Jython 2.5.2 but
|
||||||
might work an earlier version.
|
might work an earlier version.
|
||||||
@ -87,7 +87,7 @@ members are also available.
|
|||||||
|
|
||||||
For more information on using Jython, especially with regards to its limitations
|
For more information on using Jython, especially with regards to its limitations
|
||||||
in interfacing to the Java Virtual Machine, please refer to the
|
in interfacing to the Java Virtual Machine, please refer to the
|
||||||
http://www.jython.org/[Jython documentation].
|
http://www.jython.org/[Jython documentation,role=external,window=_blank].
|
||||||
|
|
||||||
After successful initialization it is possible to examine components of
|
After successful initialization it is possible to examine components of
|
||||||
Java packages, classes and live instances.
|
Java packages, classes and live instances.
|
||||||
|
@ -14,7 +14,7 @@ for Java 8 from the command line first. Ensure that at least
|
|||||||
=== IntelliJ version and Bazel plugin
|
=== IntelliJ version and Bazel plugin
|
||||||
|
|
||||||
Before downloading IntelliJ, look at the
|
Before downloading IntelliJ, look at the
|
||||||
link:https://plugins.jetbrains.com/plugin/8609-bazel/versions[JetBrains plugin repository page of the Bazel plugin]
|
link:https://plugins.jetbrains.com/plugin/8609-bazel/versions[JetBrains plugin repository page of the Bazel plugin,role=external,window=_blank]
|
||||||
to see what version of the IntelliJ IDEA it is actually compatible with.
|
to see what version of the IntelliJ IDEA it is actually compatible with.
|
||||||
|
|
||||||
Also note that the version of the Bazel plugin used in turn may or may not be
|
Also note that the version of the Bazel plugin used in turn may or may not be
|
||||||
@ -30,7 +30,7 @@ indicates that the Bazel plugin couldn't find Java 8.
|
|||||||
=== Installation of IntelliJ IDEA
|
=== Installation of IntelliJ IDEA
|
||||||
|
|
||||||
Please refer to the
|
Please refer to the
|
||||||
link:https://www.jetbrains.com/help/idea/installation-guide.html[installation guide provided by Jetbrains]
|
link:https://www.jetbrains.com/help/idea/installation-guide.html[installation guide provided by Jetbrains,role=external,window=_blank]
|
||||||
to install it on your platform. Make sure to install a version compatible with
|
to install it on your platform. Make sure to install a version compatible with
|
||||||
the Bazel plugin as mentioned above.
|
the Bazel plugin as mentioned above.
|
||||||
|
|
||||||
@ -47,7 +47,7 @@ link:https://github.com/bazelbuild/intellij[build it from source].
|
|||||||
. Search for the plugin `Bazel` (by Google).
|
. Search for the plugin `Bazel` (by Google).
|
||||||
+
|
+
|
||||||
TIP: In case the Bazel plugin is not listed, or if it shows an outdated version,
|
TIP: In case the Bazel plugin is not listed, or if it shows an outdated version,
|
||||||
verify the compatibility between the Bazel plugin and IntelliJ IDEA on link:https://plugins.jetbrains.com/plugin/8609-bazel/versions[the JetBrains plugin page].
|
verify the compatibility between the Bazel plugin and IntelliJ IDEA on link:https://plugins.jetbrains.com/plugin/8609-bazel/versions[the JetBrains plugin page,role=external,window=_blank].
|
||||||
. Install it.
|
. Install it.
|
||||||
. Restart IntelliJ IDEA.
|
. Restart IntelliJ IDEA.
|
||||||
|
|
||||||
@ -117,7 +117,7 @@ to be as close as possible. So before submitting code, please make sure to run
|
|||||||
|
|
||||||
. Download
|
. Download
|
||||||
https://raw.githubusercontent.com/google/styleguide/gh-pages/intellij-java-google-style.xml[
|
https://raw.githubusercontent.com/google/styleguide/gh-pages/intellij-java-google-style.xml[
|
||||||
intellij-java-google-style.xml].
|
intellij-java-google-style.xml,role=external,window=_blank].
|
||||||
. Go to *File -> Settings -> Editor -> Code Style*.
|
. Go to *File -> Settings -> Editor -> Code Style*.
|
||||||
. Click on the wrench icon with the tooltip _Show Scheme Actions_.
|
. Click on the wrench icon with the tooltip _Show Scheme Actions_.
|
||||||
. Click on *Import Scheme*.
|
. Click on *Import Scheme*.
|
||||||
@ -196,7 +196,7 @@ At the moment running this (local) configuration results in a
|
|||||||
use the instructions of <<dev-readme#run_daemon,Running the Daemon>> in
|
use the instructions of <<dev-readme#run_daemon,Running the Daemon>> in
|
||||||
combination with <<remote-debug,Debugging a remote Gerrit server>>.
|
combination with <<remote-debug,Debugging a remote Gerrit server>>.
|
||||||
|
|
||||||
(link:https://bugs.chromium.org/p/gerrit/issues/detail?id=11360[Issue 11360])
|
(link:https://bugs.chromium.org/p/gerrit/issues/detail?id=11360[Issue 11360,role=external,window=_blank])
|
||||||
====
|
====
|
||||||
|
|
||||||
Copy `$(gerrit_source_code)/tools/intellij/gerrit_daemon.xml` to
|
Copy `$(gerrit_source_code)/tools/intellij/gerrit_daemon.xml` to
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
= Plugin Lifecycle
|
= Plugin Lifecycle
|
||||||
|
|
||||||
Most of the plugins are hosted on the same instance as the
|
Most of the plugins are hosted on the same instance as the
|
||||||
link:https://gerrit-review.googlesource.com[Gerrit project itself] to make them
|
link:https://gerrit-review.googlesource.com[Gerrit project itself,role=external,window=_blank] to make them
|
||||||
more discoverable and have more chances to be reviewed by the whole community.
|
more discoverable and have more chances to be reviewed by the whole community.
|
||||||
|
|
||||||
[[hosting_lifecycle]]
|
[[hosting_lifecycle]]
|
||||||
@ -12,7 +12,7 @@ The process of writing a new plugin goes through different phases:
|
|||||||
- Ideation and Discussion:
|
- Ideation and Discussion:
|
||||||
+
|
+
|
||||||
The idea of creating a new plugin is posted and discussed on the
|
The idea of creating a new plugin is posted and discussed on the
|
||||||
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss] mailing list.
|
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss,role=external,window=_blank] mailing list.
|
||||||
+
|
+
|
||||||
Also see section link#ideation_discussion[Ideation and discussion] below.
|
Also see section link#ideation_discussion[Ideation and discussion] below.
|
||||||
|
|
||||||
@ -27,14 +27,14 @@ Also see section link#plugin_prototyping[Plugin Prototyping] below.
|
|||||||
+
|
+
|
||||||
The author proposes to release the plugin under the
|
The author proposes to release the plugin under the
|
||||||
link:https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 OpenSource
|
link:https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 OpenSource
|
||||||
license] and requests the plugin to be hosted on
|
license,role=external,window=_blank] and requests the plugin to be hosted on
|
||||||
link:https://gerrit-review.googlesource.com[the Gerrit project site]. The
|
link:https://gerrit-review.googlesource.com[the Gerrit project site,role=external,window=_blank]. The
|
||||||
proposal must be accepted by at least one Gerrit maintainer. In case of
|
proposal must be accepted by at least one Gerrit maintainer. In case of
|
||||||
disagreement between maintainers, the issue can be escalated to the
|
disagreement between maintainers, the issue can be escalated to the
|
||||||
link:dev-processes.html#steering-committee[Engineering Steering Committee]. If
|
link:dev-processes.html#steering-committee[Engineering Steering Committee]. If
|
||||||
the plugin is accepted, the Gerrit maintainer creates the project under the
|
the plugin is accepted, the Gerrit maintainer creates the project under the
|
||||||
plugins path on link:https://gerrit-review.googlesource.com[the Gerrit project
|
plugins path on link:https://gerrit-review.googlesource.com[the Gerrit project
|
||||||
site].
|
site,role=external,window=_blank].
|
||||||
+
|
+
|
||||||
Also see section link#plugin_proposal[Plugin Proposal] below.
|
Also see section link#plugin_proposal[Plugin Proposal] below.
|
||||||
|
|
||||||
@ -42,7 +42,7 @@ Also see section link#plugin_proposal[Plugin Proposal] below.
|
|||||||
+
|
+
|
||||||
To make the consumption of the plugin easy and to notice plugin breakages early
|
To make the consumption of the plugin easy and to notice plugin breakages early
|
||||||
the plugin author should setup build jobs on
|
the plugin author should setup build jobs on
|
||||||
link:https://gerrit-ci.gerritforge.com[the GerritForge CI] that build the
|
link:https://gerrit-ci.gerritforge.com[the GerritForge CI,role=external,window=_blank] that build the
|
||||||
plugin for each Gerrit version that it supports.
|
plugin for each Gerrit version that it supports.
|
||||||
+
|
+
|
||||||
Also see section link#build[Build] below.
|
Also see section link#build[Build] below.
|
||||||
@ -58,7 +58,7 @@ below.
|
|||||||
- Release:
|
- Release:
|
||||||
+
|
+
|
||||||
The author releases the plugin by creating a Git tag and announcing the plugin
|
The author releases the plugin by creating a Git tag and announcing the plugin
|
||||||
on the link:https://groups.google.com/d/forum/repo-discuss[repo-discuss]
|
on the link:https://groups.google.com/d/forum/repo-discuss[repo-discuss,role=external,window=_blank]
|
||||||
mailing list.
|
mailing list.
|
||||||
+
|
+
|
||||||
Also see section link#plugin_release[Plugin release] below.
|
Also see section link#plugin_release[Plugin release] below.
|
||||||
@ -84,7 +84,7 @@ identification of a gap in the Gerrit Code Review product but evolves with the
|
|||||||
contribution of ideas and suggestions by the whole community.
|
contribution of ideas and suggestions by the whole community.
|
||||||
|
|
||||||
The ideator of the plugin starts with an RFC (Request For Comments) post on the
|
The ideator of the plugin starts with an RFC (Request For Comments) post on the
|
||||||
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss] mailing list
|
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss,role=external,window=_blank] mailing list
|
||||||
with a description of the main reasons for starting a new plugin.
|
with a description of the main reasons for starting a new plugin.
|
||||||
|
|
||||||
Example of a post:
|
Example of a post:
|
||||||
@ -138,9 +138,9 @@ and try the plugin themselves.
|
|||||||
|
|
||||||
The author decides that the plugin prototype makes sense as a general purpose
|
The author decides that the plugin prototype makes sense as a general purpose
|
||||||
plugin and decides to release the code with the same
|
plugin and decides to release the code with the same
|
||||||
link:https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license]
|
link:https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license,role=external,window=_blank]
|
||||||
as the Gerrit Code Review project and have it hosted on
|
as the Gerrit Code Review project and have it hosted on
|
||||||
link:https://gerrit-review.googlesource.com[the Gerrit project site].
|
link:https://gerrit-review.googlesource.com[the Gerrit project site,role=external,window=_blank].
|
||||||
|
|
||||||
The plugin author formalizes the proposal with a follow-up of the initial RFC
|
The plugin author formalizes the proposal with a follow-up of the initial RFC
|
||||||
post and asks for public opinion on it.
|
post and asks for public opinion on it.
|
||||||
@ -167,7 +167,7 @@ project; the result of the discussion can end up in one of the following cases:
|
|||||||
- The plugin's project request is widely appreciated and formally accepted by
|
- The plugin's project request is widely appreciated and formally accepted by
|
||||||
at least one Gerrit maintainer who creates the repository as child project of
|
at least one Gerrit maintainer who creates the repository as child project of
|
||||||
'Public-Projects' on link:https://gerrit-review.googlesource.com[the Gerrit
|
'Public-Projects' on link:https://gerrit-review.googlesource.com[the Gerrit
|
||||||
project site], creates an associated plugin owners group with "Owner"
|
project site,role=external,window=_blank], creates an associated plugin owners group with "Owner"
|
||||||
permissions for the plugin and adds the plugin's author as member of it.
|
permissions for the plugin and adds the plugin's author as member of it.
|
||||||
- The plugin's project is widely appreciated; however, another existing plugin
|
- The plugin's project is widely appreciated; however, another existing plugin
|
||||||
already partially covers the same use-case and thus it would make more sense
|
already partially covers the same use-case and thus it would make more sense
|
||||||
@ -177,15 +177,15 @@ project; the result of the discussion can end up in one of the following cases:
|
|||||||
- The plugin's project is found useful; however, it is too specific to the
|
- The plugin's project is found useful; however, it is too specific to the
|
||||||
author's use-case and would not make sense outside of it. The plugin remains
|
author's use-case and would not make sense outside of it. The plugin remains
|
||||||
in a public repository, widely accessible and OpenSource, but not hosted on
|
in a public repository, widely accessible and OpenSource, but not hosted on
|
||||||
link:https://gerrit-review.googlesource.com[the Gerrit project site].
|
link:https://gerrit-review.googlesource.com[the Gerrit project site,role=external,window=_blank].
|
||||||
|
|
||||||
[[build]]
|
[[build]]
|
||||||
== Build
|
== Build
|
||||||
|
|
||||||
The plugin's maintainer creates a job on the
|
The plugin's maintainer creates a job on the
|
||||||
link:https://gerrit-ci.gerritforge.com[GerritForge CI] by creating a new YAML
|
link:https://gerrit-ci.gerritforge.com[GerritForge CI,role=external,window=_blank] by creating a new YAML
|
||||||
definition in the link:https://gerrit.googlesource.com/gerrit-ci-scripts[Gerrit
|
definition in the link:https://gerrit.googlesource.com/gerrit-ci-scripts[Gerrit
|
||||||
CI Scripts] repository.
|
CI Scripts,role=external,window=_blank] repository.
|
||||||
|
|
||||||
Example of a YAML CI job for plugins:
|
Example of a YAML CI job for plugins:
|
||||||
|
|
||||||
@ -203,7 +203,7 @@ Example of a YAML CI job for plugins:
|
|||||||
|
|
||||||
The plugin follows the same lifecycle as Gerrit Code Review and needs to be
|
The plugin follows the same lifecycle as Gerrit Code Review and needs to be
|
||||||
kept up-to-date with the current active branches, according to the
|
kept up-to-date with the current active branches, according to the
|
||||||
link:https://www.gerritcodereview.com/#support[current support policy].
|
link:https://www.gerritcodereview.com/#support[current support policy,role=external,window=_blank].
|
||||||
During the development, the plugin's maintainer can reward contributors
|
During the development, the plugin's maintainer can reward contributors
|
||||||
requesting to be more involved and making them maintainers of his plugin,
|
requesting to be more involved and making them maintainers of his plugin,
|
||||||
adding them to the list of the project owners.
|
adding them to the list of the project owners.
|
||||||
|
@ -36,7 +36,7 @@ Most of this documentation refers to either type as a plugin.
|
|||||||
|
|
||||||
To get started with the development of a plugin, take a look at
|
To get started with the development of a plugin, take a look at
|
||||||
the samples in the
|
the samples in the
|
||||||
link:https://gerrit.googlesource.com/plugins/examples[examples plugin project].
|
link:https://gerrit.googlesource.com/plugins/examples[examples plugin project,role=external,window=_blank].
|
||||||
|
|
||||||
This is a project that demonstrates the various features of the
|
This is a project that demonstrates the various features of the
|
||||||
plugin API. It can be taken as an example to develop an own plugin.
|
plugin API. It can be taken as an example to develop an own plugin.
|
||||||
@ -367,7 +367,7 @@ from the hosting server.
|
|||||||
Plugins are loaded from a single JAR file. If a plugin needs
|
Plugins are loaded from a single JAR file. If a plugin needs
|
||||||
additional libraries, it must include those dependencies within
|
additional libraries, it must include those dependencies within
|
||||||
its own JAR. Plugins built using Maven may be able to use the
|
its own JAR. Plugins built using Maven may be able to use the
|
||||||
link:http://maven.apache.org/plugins/maven-shade-plugin/[shade plugin]
|
link:http://maven.apache.org/plugins/maven-shade-plugin/[shade plugin,role=external,window=_blank]
|
||||||
to package additional dependencies. Relocating (or renaming) classes
|
to package additional dependencies. Relocating (or renaming) classes
|
||||||
should not be necessary due to the ClassLoader isolation.
|
should not be necessary due to the ClassLoader isolation.
|
||||||
|
|
||||||
@ -2189,7 +2189,7 @@ basis.
|
|||||||
|
|
||||||
Gerrit provides an extension point that enables development of
|
Gerrit provides an extension point that enables development of
|
||||||
link:https://github.com/github/git-lfs/blob/master/docs/api/v1/http-v1-batch.md[
|
link:https://github.com/github/git-lfs/blob/master/docs/api/v1/http-v1-batch.md[
|
||||||
LFS (Large File Storage)] storage plugins. Gerrit core exposes the default LFS
|
LFS (Large File Storage),role=external,window=_blank] storage plugins. Gerrit core exposes the default LFS
|
||||||
protocol endpoint `<project-name>/info/lfs/objects/batch` and forwards the requests
|
protocol endpoint `<project-name>/info/lfs/objects/batch` and forwards the requests
|
||||||
to the configured link:config-gerrit.html#lfs[lfs.plugin] plugin which implements
|
to the configured link:config-gerrit.html#lfs[lfs.plugin] plugin which implements
|
||||||
the LFS protocol. By exposing the default LFS endpoint, the git-lfs client can be
|
the LFS protocol. By exposing the default LFS endpoint, the git-lfs client can be
|
||||||
@ -2247,16 +2247,16 @@ public class S3LargeFileRepository extends S3Repository {
|
|||||||
To send Gerrit's metrics data to an external reporting backend, a plugin can
|
To send Gerrit's metrics data to an external reporting backend, a plugin can
|
||||||
get a `MetricRegistry` injected and register an instance of a class that
|
get a `MetricRegistry` injected and register an instance of a class that
|
||||||
implements the `Reporter` interface from link:http://metrics.dropwizard.io/[
|
implements the `Reporter` interface from link:http://metrics.dropwizard.io/[
|
||||||
DropWizard Metrics].
|
DropWizard Metrics,role=external,window=_blank].
|
||||||
|
|
||||||
Metric reporting plugin implementations are provided for
|
Metric reporting plugin implementations are provided for
|
||||||
link:https://gerrit.googlesource.com/plugins/metrics-reporter-jmx/[JMX],
|
link:https://gerrit.googlesource.com/plugins/metrics-reporter-jmx/[JMX,role=external,window=_blank],
|
||||||
link:https://gerrit.googlesource.com/plugins/metrics-reporter-elasticsearch/[Elastic Search],
|
link:https://gerrit.googlesource.com/plugins/metrics-reporter-elasticsearch/[Elastic Search,role=external,window=_blank],
|
||||||
and link:https://gerrit.googlesource.com/plugins/metrics-reporter-graphite/[Graphite].
|
and link:https://gerrit.googlesource.com/plugins/metrics-reporter-graphite/[Graphite,role=external,window=_blank].
|
||||||
|
|
||||||
There is also a working example of reporting metrics to the console in the
|
There is also a working example of reporting metrics to the console in the
|
||||||
link:https://gerrit.googlesource.com/plugins/cookbook-plugin/+/master/src/main/java/com/googlesource/gerrit/plugins/cookbook/ConsoleMetricReporter.java[
|
link:https://gerrit.googlesource.com/plugins/cookbook-plugin/+/master/src/main/java/com/googlesource/gerrit/plugins/cookbook/ConsoleMetricReporter.java[
|
||||||
cookbook plugin].
|
cookbook plugin,role=external,window=_blank].
|
||||||
|
|
||||||
=== Providing own metrics
|
=== Providing own metrics
|
||||||
|
|
||||||
@ -2293,7 +2293,7 @@ will cause the metrics to be recorded under `my-metrics/${metric-name}`.
|
|||||||
|
|
||||||
See the replication metrics in the
|
See the replication metrics in the
|
||||||
link:https://gerrit.googlesource.com/plugins/replication/+/master/src/main/java/com/googlesource/gerrit/plugins/replication/ReplicationMetrics.java[
|
link:https://gerrit.googlesource.com/plugins/replication/+/master/src/main/java/com/googlesource/gerrit/plugins/replication/ReplicationMetrics.java[
|
||||||
replication plugin] for an example of usage.
|
replication plugin,role=external,window=_blank] for an example of usage.
|
||||||
|
|
||||||
[[account-patch-review-store]]
|
[[account-patch-review-store]]
|
||||||
== AccountPatchReviewStore
|
== AccountPatchReviewStore
|
||||||
@ -2338,7 +2338,7 @@ prefix is configurable by setting the `Gerrit-HttpDocumentationPrefix`
|
|||||||
attribute.
|
attribute.
|
||||||
|
|
||||||
Documentation may be written in the Markdown flavor
|
Documentation may be written in the Markdown flavor
|
||||||
link:https://github.com/vsch/flexmark-java[flexmark-java]
|
link:https://github.com/vsch/flexmark-java[flexmark-java,role=external,window=_blank]
|
||||||
if the file name ends with `.md`. Gerrit will automatically convert
|
if the file name ends with `.md`. Gerrit will automatically convert
|
||||||
Markdown to HTML if accessed with extension `.html`.
|
Markdown to HTML if accessed with extension `.html`.
|
||||||
|
|
||||||
|
@ -30,7 +30,7 @@ The steering committee has 5 members:
|
|||||||
period of 1 year (see link:#steering-committee-election[below])
|
period of 1 year (see link:#steering-committee-election[below])
|
||||||
|
|
||||||
Refer to the project homepage for the link:https://www.gerritcodereview.com/members.html#engineering-steering-committee[
|
Refer to the project homepage for the link:https://www.gerritcodereview.com/members.html#engineering-steering-committee[
|
||||||
list of current committee members].
|
list of current committee members,role=external,window=_blank].
|
||||||
|
|
||||||
The steering committee should act in the interest of the Gerrit project
|
The steering committee should act in the interest of the Gerrit project
|
||||||
and the whole Gerrit community.
|
and the whole Gerrit community.
|
||||||
@ -84,7 +84,7 @@ See link:dev-design-docs.html#review[here].
|
|||||||
[[versioning]]
|
[[versioning]]
|
||||||
== Semantic versioning
|
== Semantic versioning
|
||||||
|
|
||||||
Gerrit follows a light link:https://semver.org/[semantic versioning scheme] MAJOR.MINOR[.PATCH[.HOTFIX]]
|
Gerrit follows a light link:https://semver.org/[semantic versioning scheme,role=external,window=_blank] MAJOR.MINOR[.PATCH[.HOTFIX]]
|
||||||
format:
|
format:
|
||||||
|
|
||||||
* MAJOR is incremented when there are substantial incompatible changes and/or
|
* MAJOR is incremented when there are substantial incompatible changes and/or
|
||||||
@ -182,7 +182,7 @@ available.
|
|||||||
|
|
||||||
To report a security vulnerability file a
|
To report a security vulnerability file a
|
||||||
link:https://bugs.chromium.org/p/gerrit/issues/entry?template=Security+Issue[
|
link:https://bugs.chromium.org/p/gerrit/issues/entry?template=Security+Issue[
|
||||||
security issue] in the Gerrit issue tracker. The visibility of issues that are
|
security issue,role=external,window=_blank] in the Gerrit issue tracker. The visibility of issues that are
|
||||||
created with the `Security Issue` template is automatically restricted to
|
created with the `Security Issue` template is automatically restricted to
|
||||||
Gerrit maintainers and a few long-term contributors. This means as a reporter
|
Gerrit maintainers and a few long-term contributors. This means as a reporter
|
||||||
you may not be able to see the issue once it is created. Security issues are
|
you may not be able to see the issue once it is created. Security issues are
|
||||||
@ -222,7 +222,7 @@ community is informed about the security vulnerability with the advise to
|
|||||||
address the security vulnerability immediately (either by upgrading to a fixed
|
address the security vulnerability immediately (either by upgrading to a fixed
|
||||||
release or applying the mitigation). The information about the security
|
release or applying the mitigation). The information about the security
|
||||||
vulnerability is disclosed via the
|
vulnerability is disclosed via the
|
||||||
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss] mailing list.
|
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss,role=external,window=_blank] mailing list.
|
||||||
|
|
||||||
[[handle-security-issue]]
|
[[handle-security-issue]]
|
||||||
=== Handling of the Security Vulnerability
|
=== Handling of the Security Vulnerability
|
||||||
@ -253,7 +253,7 @@ link:intro-user.html[security-fixes]).
|
|||||||
+
|
+
|
||||||
Instead security fixes should be implemented and reviewed in the non-public
|
Instead security fixes should be implemented and reviewed in the non-public
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/gerrit-security-fixes[
|
link:https://gerrit-review.googlesource.com/admin/repos/gerrit-security-fixes[
|
||||||
gerrit-security-fixes] repository which is only accessible by Gerrit
|
gerrit-security-fixes,role=external,window=_blank] repository which is only accessible by Gerrit
|
||||||
maintainers and Gerrit community members that work on security fixes.
|
maintainers and Gerrit community members that work on security fixes.
|
||||||
+
|
+
|
||||||
The change that fixes the security vulnerability should contain an integration
|
The change that fixes the security vulnerability should contain an integration
|
||||||
@ -284,7 +284,7 @@ The announcement should recommend to upgrade to fixed releases immediately.
|
|||||||
Once all releases are ready and tested and the announcement is prepared, the
|
Once all releases are ready and tested and the announcement is prepared, the
|
||||||
releases should be all published at the same time. Immediately after that, the
|
releases should be all published at the same time. Immediately after that, the
|
||||||
announcement should be sent out to the
|
announcement should be sent out to the
|
||||||
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss] mailing list.
|
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss,role=external,window=_blank] mailing list.
|
||||||
+
|
+
|
||||||
This ends the embargo and any issue that discusses the security vulnerability
|
This ends the embargo and any issue that discusses the security vulnerability
|
||||||
should be made public.
|
should be made public.
|
||||||
@ -293,7 +293,7 @@ should be made public.
|
|||||||
+
|
+
|
||||||
The ESC should discuss if there are any learnings from the security
|
The ESC should discuss if there are any learnings from the security
|
||||||
vulnerability and define action items to follow up in the
|
vulnerability and define action items to follow up in the
|
||||||
link:https://bugs.chromium.org/p/gerrit[issue tracker].
|
link:https://bugs.chromium.org/p/gerrit[issue tracker,role=external,window=_blank].
|
||||||
|
|
||||||
[[core-plugins]]
|
[[core-plugins]]
|
||||||
== Core Plugins
|
== Core Plugins
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
= Gerrit Code Review: Developer Setup
|
= Gerrit Code Review: Developer Setup
|
||||||
|
|
||||||
To build a developer instance, you'll need link:https://bazel.build/[Bazel] to
|
To build a developer instance, you'll need link:https://bazel.build/[Bazel,role=external,window=_blank] to
|
||||||
compile the code.
|
compile the code.
|
||||||
|
|
||||||
== Git Setup
|
== Git Setup
|
||||||
@ -31,7 +31,7 @@ the submodules.
|
|||||||
|
|
||||||
CAUTION: If you store Eclipse or IntelliJ project files in the Gerrit source
|
CAUTION: If you store Eclipse or IntelliJ project files in the Gerrit source
|
||||||
directories, do *_not_* run `git clean -fdx`. Doing so may remove untracked files and damage your project. For more information, see
|
directories, do *_not_* run `git clean -fdx`. Doing so may remove untracked files and damage your project. For more information, see
|
||||||
link:https://git-scm.com/docs/git-clean[git-clean].
|
link:https://git-scm.com/docs/git-clean[git-clean,role=external,window=_blank].
|
||||||
|
|
||||||
Run the following:
|
Run the following:
|
||||||
|
|
||||||
|
@ -11,7 +11,7 @@ To be able to publish artifacts to Maven Central some preparations must
|
|||||||
be done:
|
be done:
|
||||||
|
|
||||||
* Create an account on
|
* Create an account on
|
||||||
link:https://issues.sonatype.org/secure/Signup!default.jspa[Sonatype's Jira].
|
link:https://issues.sonatype.org/secure/Signup!default.jspa[Sonatype's Jira,role=external,window=_blank].
|
||||||
+
|
+
|
||||||
Sonatype is the company that runs Maven Central and you need a Sonatype
|
Sonatype is the company that runs Maven Central and you need a Sonatype
|
||||||
account to be able to upload artifacts to Maven Central.
|
account to be able to upload artifacts to Maven Central.
|
||||||
@ -30,7 +30,7 @@ account to be able to upload artifacts to Maven Central.
|
|||||||
repository on Maven Central:
|
repository on Maven Central:
|
||||||
+
|
+
|
||||||
Ask for this permission by adding a comment on the
|
Ask for this permission by adding a comment on the
|
||||||
link:https://issues.sonatype.org/browse/OSSRH-7392[OSSRH-7392] Jira
|
link:https://issues.sonatype.org/browse/OSSRH-7392[OSSRH-7392,role=external,window=_blank] Jira
|
||||||
ticket at Sonatype.
|
ticket at Sonatype.
|
||||||
+
|
+
|
||||||
The request needs to be approved by someone who already has this
|
The request needs to be approved by someone who already has this
|
||||||
@ -43,7 +43,7 @@ the upload to Maven Central, and to sign the release announcement email.
|
|||||||
+
|
+
|
||||||
Generate and publish a PGP key as described in
|
Generate and publish a PGP key as described in
|
||||||
link:http://central.sonatype.org/pages/working-with-pgp-signatures.html[
|
link:http://central.sonatype.org/pages/working-with-pgp-signatures.html[
|
||||||
Working with PGP Signatures]. In addition to the keyserver mentioned
|
Working with PGP Signatures,role=external,window=_blank]. In addition to the keyserver mentioned
|
||||||
there it is recommended to also publish the key to the
|
there it is recommended to also publish the key to the
|
||||||
link:https://keyserver.ubuntu.com/[Ubuntu key server].
|
link:https://keyserver.ubuntu.com/[Ubuntu key server].
|
||||||
+
|
+
|
||||||
@ -51,7 +51,7 @@ Please be aware that after publishing your public key it may take a
|
|||||||
while until it is visible to the Sonatype server.
|
while until it is visible to the Sonatype server.
|
||||||
+
|
+
|
||||||
Add an entry for the public key in the
|
Add an entry for the public key in the
|
||||||
link:https://gerrit.googlesource.com/homepage/+/md-pages/releases/public-keys.md[key list]
|
link:https://gerrit.googlesource.com/homepage/+/md-pages/releases/public-keys.md[key list,role=external,window=_blank]
|
||||||
on the homepage.
|
on the homepage.
|
||||||
+
|
+
|
||||||
The PGP passphrase can be put in `~/.m2/settings.xml`:
|
The PGP passphrase can be put in `~/.m2/settings.xml`:
|
||||||
@ -80,7 +80,7 @@ It can also be included in the key chain on OS X.
|
|||||||
|
|
||||||
Gerrit Subproject Artifacts are stored on
|
Gerrit Subproject Artifacts are stored on
|
||||||
link:https://developers.google.com/storage/[Google Cloud Storage].
|
link:https://developers.google.com/storage/[Google Cloud Storage].
|
||||||
Via the link:https://console.developers.google.com/project/164060093628[Developers Console] the
|
Via the link:https://console.developers.google.com/project/164060093628[Developers Console,role=external,window=_blank] the
|
||||||
Gerrit maintainers have access to the `Gerrit Code Review` project.
|
Gerrit maintainers have access to the `Gerrit Code Review` project.
|
||||||
This projects host several buckets for storing Gerrit artifacts:
|
This projects host several buckets for storing Gerrit artifacts:
|
||||||
|
|
||||||
@ -96,7 +96,7 @@ Bucket to store Gerrit Subproject Artifacts (e.g. Prolog Cafe).
|
|||||||
To upload artifacts to a bucket the user must authenticate with a
|
To upload artifacts to a bucket the user must authenticate with a
|
||||||
username and password. The username and password need to be retrieved
|
username and password. The username and password need to be retrieved
|
||||||
from the link:https://console.cloud.google.com/storage/settings?project=api-project-164060093628[
|
from the link:https://console.cloud.google.com/storage/settings?project=api-project-164060093628[
|
||||||
Storage Setting in the Google Cloud Platform Console]:
|
Storage Setting in the Google Cloud Platform Console,role=external,window=_blank]:
|
||||||
|
|
||||||
Select the `Interoperability` tab, and if no keys are listed under
|
Select the `Interoperability` tab, and if no keys are listed under
|
||||||
`Interoperable storage access keys`, select 'Create a new key'.
|
`Interoperable storage access keys`, select 'Create a new key'.
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
This step is only necessary if we need to create an unofficial JGit
|
This step is only necessary if we need to create an unofficial JGit
|
||||||
snapshot release and publish it to the
|
snapshot release and publish it to the
|
||||||
link:https://developers.google.com/storage/[Google Cloud Storage].
|
link:https://developers.google.com/storage/[Google Cloud Storage,role=external,window=_blank].
|
||||||
|
|
||||||
[[prepare-environment]]
|
[[prepare-environment]]
|
||||||
== Prepare the Maven Environment
|
== Prepare the Maven Environment
|
||||||
|
@ -158,14 +158,14 @@ the `version.bzl` file:
|
|||||||
** SNAPSHOT versions are directly uploaded into the Sonatype snapshots
|
** SNAPSHOT versions are directly uploaded into the Sonatype snapshots
|
||||||
repository and no further action is needed:
|
repository and no further action is needed:
|
||||||
+
|
+
|
||||||
https://oss.sonatype.org/content/repositories/snapshots/com/google/gerrit/
|
https://oss.sonatype.org/content/repositories/snapshots/com/google/gerrit/[role=external,window=_blank]
|
||||||
|
|
||||||
** Release versions are uploaded into a staging repository in the
|
** Release versions are uploaded into a staging repository in the
|
||||||
link:https://oss.sonatype.org/[Sonatype Nexus Server].
|
link:https://oss.sonatype.org/[Sonatype Nexus Server].
|
||||||
|
|
||||||
* Verify the staging repository
|
* Verify the staging repository
|
||||||
|
|
||||||
** Go to the link:https://oss.sonatype.org/[Sonatype Nexus Server] and
|
** Go to the link:https://oss.sonatype.org/[Sonatype Nexus Server,role=external,window=_blank] and
|
||||||
sign in with your Sonatype credentials.
|
sign in with your Sonatype credentials.
|
||||||
|
|
||||||
** Click on 'Build Promotion' in the left navigation bar under
|
** Click on 'Build Promotion' in the left navigation bar under
|
||||||
@ -188,7 +188,7 @@ modified anymore, but you may still drop it if you find any issues.
|
|||||||
** Test closed staging repository
|
** Test closed staging repository
|
||||||
+
|
+
|
||||||
Once a repository is closed you can find the URL to it in the `Summary`
|
Once a repository is closed you can find the URL to it in the `Summary`
|
||||||
section, e.g. https://oss.sonatype.org/content/repositories/comgooglegerrit-1029
|
section, e.g. https://oss.sonatype.org/content/repositories/comgooglegerrit-1029[role=external,window=_blank]
|
||||||
+
|
+
|
||||||
Use this URL for further testing of the artifacts in this repository,
|
Use this URL for further testing of the artifacts in this repository,
|
||||||
e.g. to try building a plugin against the plugin API in this repository
|
e.g. to try building a plugin against the plugin API in this repository
|
||||||
@ -207,7 +207,7 @@ update the version in the `*_pom.xml` and configure the repository:
|
|||||||
+
|
+
|
||||||
How to release a staging repository is described in the
|
How to release a staging repository is described in the
|
||||||
link:https://docs.sonatype.org/display/Repository/Sonatype+OSS+Maven+Repository+Usage+Guide#SonatypeOSSMavenRepositoryUsageGuide-8.a.2.ReleasingaStagingRepository[
|
link:https://docs.sonatype.org/display/Repository/Sonatype+OSS+Maven+Repository+Usage+Guide#SonatypeOSSMavenRepositoryUsageGuide-8.a.2.ReleasingaStagingRepository[
|
||||||
Sonatype OSS Maven Repository Usage Guide].
|
Sonatype OSS Maven Repository Usage Guide,role=external,window=_blank].
|
||||||
+
|
+
|
||||||
[WARNING]
|
[WARNING]
|
||||||
Releasing artifacts to Maven Central cannot be undone!
|
Releasing artifacts to Maven Central cannot be undone!
|
||||||
@ -217,17 +217,17 @@ link:https://oss.sonatype.org/[Sonatype Nexus Server], select it and
|
|||||||
click on `Release`.
|
click on `Release`.
|
||||||
|
|
||||||
** The released artifacts are available in
|
** The released artifacts are available in
|
||||||
https://oss.sonatype.org/content/repositories/releases/com/google/gerrit/
|
https://oss.sonatype.org/content/repositories/releases/com/google/gerrit/[role=external,window=_blank]
|
||||||
|
|
||||||
** It may take up to 2 hours until the artifacts appear on Maven
|
** It may take up to 2 hours until the artifacts appear on Maven
|
||||||
Central:
|
Central:
|
||||||
+
|
+
|
||||||
http://central.maven.org/maven2/com/google/gerrit/
|
http://central.maven.org/maven2/com/google/gerrit/[role=external,window=_blank]
|
||||||
|
|
||||||
* [optional]: View download statistics
|
* [optional]: View download statistics
|
||||||
|
|
||||||
** Sign in to the
|
** Sign in to the
|
||||||
link:https://oss.sonatype.org/[Sonatype Nexus Server].
|
link:https://oss.sonatype.org/[Sonatype Nexus Server,role=external,window=_blank].
|
||||||
|
|
||||||
** Click on 'Views/Repositories' in the left navigation bar under
|
** Click on 'Views/Repositories' in the left navigation bar under
|
||||||
'Central Statistics'.
|
'Central Statistics'.
|
||||||
@ -239,7 +239,7 @@ link:https://oss.sonatype.org/[Sonatype Nexus Server].
|
|||||||
==== Publish the Gerrit WAR to the Google Cloud Storage
|
==== Publish the Gerrit WAR to the Google Cloud Storage
|
||||||
|
|
||||||
* go to the link:https://console.cloud.google.com/storage/browser/gerrit-releases/?project=api-project-164060093628[
|
* go to the link:https://console.cloud.google.com/storage/browser/gerrit-releases/?project=api-project-164060093628[
|
||||||
gerrit-releases bucket in the Google cloud storage console]
|
gerrit-releases bucket in the Google cloud storage console,role=external,window=_blank]
|
||||||
* make sure you are signed in with your Gmail account
|
* make sure you are signed in with your Gmail account
|
||||||
* manually upload the Gerrit WAR file by using the `Upload` button
|
* manually upload the Gerrit WAR file by using the `Upload` button
|
||||||
|
|
||||||
@ -248,7 +248,7 @@ gerrit-releases bucket in the Google cloud storage console]
|
|||||||
|
|
||||||
* Create the stable branch `stable-$version` in the `gerrit` project via the
|
* Create the stable branch `stable-$version` in the `gerrit` project via the
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/gerrit,branches[
|
link:https://gerrit-review.googlesource.com/admin/repos/gerrit,branches[
|
||||||
Gerrit Web UI] or by push.
|
Gerrit Web UI,role=external,window=_blank] or by push.
|
||||||
|
|
||||||
* Push the commits done on `stable-$version` to `refs/for/stable-$version` and
|
* Push the commits done on `stable-$version` to `refs/for/stable-$version` and
|
||||||
get them merged.
|
get them merged.
|
||||||
@ -282,7 +282,7 @@ Push the new Release Tag on the plugins:
|
|||||||
* Upload the files manually via web browser to the appropriate folder
|
* Upload the files manually via web browser to the appropriate folder
|
||||||
in the
|
in the
|
||||||
link:https://console.cloud.google.com/storage/browser/gerrit-documentation/?project=api-project-164060093628[
|
link:https://console.cloud.google.com/storage/browser/gerrit-documentation/?project=api-project-164060093628[
|
||||||
gerrit-documentation] storage bucket.
|
gerrit-documentation,role=external,window=_blank] storage bucket.
|
||||||
|
|
||||||
[[finalize-release-notes]]
|
[[finalize-release-notes]]
|
||||||
=== Finalize the Release Notes
|
=== Finalize the Release Notes
|
||||||
@ -298,7 +298,7 @@ latest version bold.
|
|||||||
==== Update homepage links
|
==== Update homepage links
|
||||||
|
|
||||||
Upload a change on the link:https://gerrit-review.googlesource.com/admin/repos/homepage[
|
Upload a change on the link:https://gerrit-review.googlesource.com/admin/repos/homepage[
|
||||||
homepage project] to change the version numbers to the new version.
|
homepage project,role=external,window=_blank] to change the version numbers to the new version.
|
||||||
|
|
||||||
[[update-issues]]
|
[[update-issues]]
|
||||||
==== Update the Issues
|
==== Update the Issues
|
||||||
@ -364,7 +364,7 @@ none of the changes/fixes ever get lost.
|
|||||||
|
|
||||||
Bazlets is used by gerrit plugins to simplify build process. To allow the
|
Bazlets is used by gerrit plugins to simplify build process. To allow the
|
||||||
new released version to be used by gerrit plugins,
|
new released version to be used by gerrit plugins,
|
||||||
link:https://gerrit.googlesource.com/bazlets/+/master/gerrit_api.bzl#8[gerrit_api.bzl]
|
link:https://gerrit.googlesource.com/bazlets/+/master/gerrit_api.bzl#8[gerrit_api.bzl,role=external,window=_blank]
|
||||||
must reference the new version. Upload a change to bazlets repository with
|
must reference the new version. Upload a change to bazlets repository with
|
||||||
api version upgrade.
|
api version upgrade.
|
||||||
|
|
||||||
|
@ -14,19 +14,19 @@ Gerrit community or get in touch by other means.
|
|||||||
There are many possibilities to support the project, e.g.:
|
There are many possibilities to support the project, e.g.:
|
||||||
|
|
||||||
* get involved in discussions on the
|
* get involved in discussions on the
|
||||||
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss]
|
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss,role=external,window=_blank]
|
||||||
mailing list (post your questions, provide feedback, share your
|
mailing list (post your questions, provide feedback, share your
|
||||||
experiences, help other users)
|
experiences, help other users)
|
||||||
* attend community events like user summits (see
|
* attend community events like user summits (see
|
||||||
link:https://calendar.google.com/calendar?cid=Z29vZ2xlLmNvbV91YmIxcGxhNmlqNzg1b3FianI2MWg0dmRpc0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t[
|
link:https://calendar.google.com/calendar?cid=Z29vZ2xlLmNvbV91YmIxcGxhNmlqNzg1b3FianI2MWg0dmRpc0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t[
|
||||||
community calendar])
|
community calendar,role=external,window=_blank])
|
||||||
* report link:https://bugs.chromium.org/p/gerrit/issues/list[issues]
|
* report link:https://bugs.chromium.org/p/gerrit/issues/list[issues,role=external,window=_blank]
|
||||||
and help to clarify existing issues
|
and help to clarify existing issues
|
||||||
* provide feedback on
|
* provide feedback on
|
||||||
link:https://www.gerritcodereview.com/releases-readme.html[new
|
link:https://www.gerritcodereview.com/releases-readme.html[new
|
||||||
releases and release candidates]
|
releases and release candidates,role=external,window=_blank]
|
||||||
* review
|
* review
|
||||||
link:https://gerrit-review.googlesource.com/q/status:open[changes]
|
link:https://gerrit-review.googlesource.com/q/status:open[changes,role=external,window=_blank]
|
||||||
and help to verify that they work as advertised, comment if you like
|
and help to verify that they work as advertised, comment if you like
|
||||||
or dislike a feature
|
or dislike a feature
|
||||||
* serve as contact person for a proprietary Gerrit installation and
|
* serve as contact person for a proprietary Gerrit installation and
|
||||||
@ -35,7 +35,7 @@ There are many possibilities to support the project, e.g.:
|
|||||||
Supporters can:
|
Supporters can:
|
||||||
|
|
||||||
* post on the
|
* post on the
|
||||||
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss]
|
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss,role=external,window=_blank]
|
||||||
mailing list (Please note that the `repo-discuss` mailing list is
|
mailing list (Please note that the `repo-discuss` mailing list is
|
||||||
managed to prevent spam posts. This means posts from new participants
|
managed to prevent spam posts. This means posts from new participants
|
||||||
must be approved manually before they appear on the mailing list.
|
must be approved manually before they appear on the mailing list.
|
||||||
@ -43,7 +43,7 @@ Supporters can:
|
|||||||
participate in mailing list discussions frequently are approved
|
participate in mailing list discussions frequently are approved
|
||||||
automatically)
|
automatically)
|
||||||
* comment on
|
* comment on
|
||||||
link:https://gerrit-review.googlesource.com/q/status:open[changes]
|
link:https://gerrit-review.googlesource.com/q/status:open[changes,role=external,window=_blank]
|
||||||
and vote from `-1` to `+1` on the `Code-Review` label (these votes
|
and vote from `-1` to `+1` on the `Code-Review` label (these votes
|
||||||
are important to understand the interest in a change and to address
|
are important to understand the interest in a change and to address
|
||||||
concerns early, however link:#maintainer[maintainers] can
|
concerns early, however link:#maintainer[maintainers] can
|
||||||
@ -53,7 +53,7 @@ Supporters can:
|
|||||||
permissions to vote on the `Verified` label are granted by request,
|
permissions to vote on the `Verified` label are granted by request,
|
||||||
see below)
|
see below)
|
||||||
* file issues in the link:https://bugs.chromium.org/p/gerrit/issues/list[
|
* file issues in the link:https://bugs.chromium.org/p/gerrit/issues/list[
|
||||||
issue tracker] and comment on existing issues
|
issue tracker,role=external,window=_blank] and comment on existing issues
|
||||||
* support the
|
* support the
|
||||||
link:dev-processes.html#design-driven-contribution-process[
|
link:dev-processes.html#design-driven-contribution-process[
|
||||||
design-driven contribution process] by reviewing incoming
|
design-driven contribution process] by reviewing incoming
|
||||||
@ -62,7 +62,7 @@ Supporters can:
|
|||||||
|
|
||||||
Supporters who want to engage further can get additional privileges
|
Supporters who want to engage further can get additional privileges
|
||||||
on request (ask for it on the
|
on request (ask for it on the
|
||||||
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss]
|
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss,role=external,window=_blank]
|
||||||
mailing list):
|
mailing list):
|
||||||
|
|
||||||
* become member of the `gerrit-verifiers` group, which allows to:
|
* become member of the `gerrit-verifiers` group, which allows to:
|
||||||
@ -71,10 +71,10 @@ mailing list):
|
|||||||
** edit topics on all open changes
|
** edit topics on all open changes
|
||||||
** abandon changes
|
** abandon changes
|
||||||
* approve posts to the
|
* approve posts to the
|
||||||
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss]
|
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss,role=external,window=_blank]
|
||||||
mailing list
|
mailing list
|
||||||
* administrate issues in the
|
* administrate issues in the
|
||||||
link:https://bugs.chromium.org/p/gerrit/issues/list[issue tracker]
|
link:https://bugs.chromium.org/p/gerrit/issues/list[issue tracker,role=external,window=_blank]
|
||||||
|
|
||||||
Supporters can become link:#contributor[contributors] by signing a
|
Supporters can become link:#contributor[contributors] by signing a
|
||||||
contributor license agreement and contributing code to the Gerrit
|
contributor license agreement and contributing code to the Gerrit
|
||||||
@ -87,7 +87,7 @@ Everyone who has a valid link:dev-cla.html[contributor license
|
|||||||
agreement] and who has link:dev-contributing.html[contributed] at least
|
agreement] and who has link:dev-contributing.html[contributed] at least
|
||||||
one change to any project on
|
one change to any project on
|
||||||
link:https://gerrit-review.googlesource.com/[
|
link:https://gerrit-review.googlesource.com/[
|
||||||
gerrit-review.googlesource.com] is a contributor.
|
gerrit-review.googlesource.com,role=external,window=_blank] is a contributor.
|
||||||
|
|
||||||
Contributions can be:
|
Contributions can be:
|
||||||
|
|
||||||
@ -123,10 +123,10 @@ done.
|
|||||||
|
|
||||||
Contributors may also be invited to join the Gerrit hackathons which
|
Contributors may also be invited to join the Gerrit hackathons which
|
||||||
happen regularly (e.g. twice a year). Hackathons are announced on the
|
happen regularly (e.g. twice a year). Hackathons are announced on the
|
||||||
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss]
|
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss,role=external,window=_blank]
|
||||||
mailing list (also see
|
mailing list (also see
|
||||||
link:https://calendar.google.com/calendar?cid=Z29vZ2xlLmNvbV91YmIxcGxhNmlqNzg1b3FianI2MWg0dmRpc0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t[
|
link:https://calendar.google.com/calendar?cid=Z29vZ2xlLmNvbV91YmIxcGxhNmlqNzg1b3FianI2MWg0dmRpc0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t[
|
||||||
community calendar]).
|
community calendar,role=external,window=_blank]).
|
||||||
|
|
||||||
Outstanding contributors that are actively engaged in the community, in
|
Outstanding contributors that are actively engaged in the community, in
|
||||||
activities outlined above, may be nominated as link:#maintainer[
|
activities outlined above, may be nominated as link:#maintainer[
|
||||||
@ -138,7 +138,7 @@ maintainers].
|
|||||||
Maintainers are the gatekeepers of the project and are in charge of
|
Maintainers are the gatekeepers of the project and are in charge of
|
||||||
approving and submitting changes. Refer to the project homepage for
|
approving and submitting changes. Refer to the project homepage for
|
||||||
the link:https://www.gerritcodereview.com/members.html#maintainers[
|
the link:https://www.gerritcodereview.com/members.html#maintainers[
|
||||||
list of current maintainers].
|
list of current maintainers,role=external,window=_blank].
|
||||||
|
|
||||||
Maintainers should only approve changes that:
|
Maintainers should only approve changes that:
|
||||||
|
|
||||||
@ -185,20 +185,20 @@ Maintainers can:
|
|||||||
link:dev-processes.html#project-governance[Project Governance]
|
link:dev-processes.html#project-governance[Project Governance]
|
||||||
* nominate new maintainers and vote on nominations (see below)
|
* nominate new maintainers and vote on nominations (see below)
|
||||||
* administrate the link:https://groups.google.com/d/forum/repo-discuss[
|
* administrate the link:https://groups.google.com/d/forum/repo-discuss[
|
||||||
mailing list], the
|
mailing list,role=external,window=_blank], the
|
||||||
link:https://bugs.chromium.org/p/gerrit/issues/list[issue tracker]
|
link:https://bugs.chromium.org/p/gerrit/issues/list[issue tracker,role=external,window=_blank]
|
||||||
and the link:https://www.gerritcodereview.com/[homepage]
|
and the link:https://www.gerritcodereview.com/[homepage,role=external,window=_blank]
|
||||||
* gain permissions to do Gerrit releases and publish release artifacts
|
* gain permissions to do Gerrit releases and publish release artifacts
|
||||||
* create new projects and groups on
|
* create new projects and groups on
|
||||||
link:https://gerrit-review.googlesource.com/[
|
link:https://gerrit-review.googlesource.com/[
|
||||||
gerrit-review.googlesource.com]
|
gerrit-review.googlesource.com,role=external,window=_blank]
|
||||||
* administrate the Gerrit projects on
|
* administrate the Gerrit projects on
|
||||||
link:https://gerrit-review.googlesource.com/[
|
link:https://gerrit-review.googlesource.com/[
|
||||||
gerrit-review.googlesource.com] (e.g. edit ACLs, update project
|
gerrit-review.googlesource.com,role=external,window=_blank] (e.g. edit ACLs, update project
|
||||||
configuration)
|
configuration)
|
||||||
* create events in the
|
* create events in the
|
||||||
link:https://calendar.google.com/calendar?cid=Z29vZ2xlLmNvbV91YmIxcGxhNmlqNzg1b3FianI2MWg0dmRpc0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t[
|
link:https://calendar.google.com/calendar?cid=Z29vZ2xlLmNvbV91YmIxcGxhNmlqNzg1b3FianI2MWg0dmRpc0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t[
|
||||||
community calendar]
|
community calendar,role=external,window=_blank]
|
||||||
* discuss with other maintainers on the private maintainers mailing
|
* discuss with other maintainers on the private maintainers mailing
|
||||||
list and Slack channel
|
list and Slack channel
|
||||||
|
|
||||||
@ -243,7 +243,7 @@ governs the project, see link:dev-processes.html#project-governance[Project Gove
|
|||||||
Members of the steering committee are expected to act in the interest
|
Members of the steering committee are expected to act in the interest
|
||||||
of the Gerrit project and the whole Gerrit community. Refer to the project
|
of the Gerrit project and the whole Gerrit community. Refer to the project
|
||||||
homepage for the link:https://www.gerritcodereview.com/members.html#engineering-steering-committee[
|
homepage for the link:https://www.gerritcodereview.com/members.html#engineering-steering-committee[
|
||||||
list of current committee members].
|
list of current committee members,role=external,window=_blank].
|
||||||
|
|
||||||
For those that are familiar with scrum, the steering committee member
|
For those that are familiar with scrum, the steering committee member
|
||||||
role is similar to the role of an agile product owner.
|
role is similar to the role of an agile product owner.
|
||||||
@ -254,7 +254,7 @@ responsibilities and live up to the promise of answering incoming
|
|||||||
requests in a timely manner.
|
requests in a timely manner.
|
||||||
|
|
||||||
Community members may submit new items under the
|
Community members may submit new items under the
|
||||||
link:https://bugs.chromium.org/p/gerrit/issues/list?q=component:ESC[ESC component]
|
link:https://bugs.chromium.org/p/gerrit/issues/list?q=component:ESC[ESC component,role=external,window=_blank]
|
||||||
in the issue tracker, or add that component to existing items, to raise them to
|
in the issue tracker, or add that component to existing items, to raise them to
|
||||||
the attention of ESC members.
|
the attention of ESC members.
|
||||||
|
|
||||||
@ -301,7 +301,7 @@ design doc].
|
|||||||
Community managers should act as stakeholders for the Gerrit community
|
Community managers should act as stakeholders for the Gerrit community
|
||||||
and focus on the health of the community. Refer to the project homepage
|
and focus on the health of the community. Refer to the project homepage
|
||||||
for the link:https://www.gerritcodereview.com/members.html#community-managers[
|
for the link:https://www.gerritcodereview.com/members.html#community-managers[
|
||||||
list of current community managers].
|
list of current community managers,role=external,window=_blank].
|
||||||
|
|
||||||
Tasks:
|
Tasks:
|
||||||
|
|
||||||
@ -315,7 +315,7 @@ Tasks:
|
|||||||
* serve as contact person for community issues
|
* serve as contact person for community issues
|
||||||
|
|
||||||
Community members may submit new items under the
|
Community members may submit new items under the
|
||||||
link:https://bugs.chromium.org/p/gerrit/issues/list?q=component:Community[Community component]
|
link:https://bugs.chromium.org/p/gerrit/issues/list?q=component:Community[Community component,role=external,window=_blank]
|
||||||
backlog, for community managers to refine. Only public topics should be
|
backlog, for community managers to refine. Only public topics should be
|
||||||
issued through that backlog.
|
issued through that backlog.
|
||||||
|
|
||||||
|
@ -1,10 +1,10 @@
|
|||||||
= Gerrit Code Review - Starter Projects
|
= Gerrit Code Review - Starter Projects
|
||||||
|
|
||||||
We have created a
|
We have created a
|
||||||
link:https://bugs.chromium.org/p/gerrit/issues/list?can=2&q=label%3AStarterProject[StarterProject]
|
link:https://bugs.chromium.org/p/gerrit/issues/list?can=2&q=label%3AStarterProject[StarterProject,role=external,window=_blank]
|
||||||
category in the issue tracker and try to assign easy hack projects to it. If in
|
category in the issue tracker and try to assign easy hack projects to it. If in
|
||||||
doubt, do not hesitate to ask on the developer
|
doubt, do not hesitate to ask on the developer
|
||||||
link:https://groups.google.com/forum/#!forum/repo-discuss[mailing list].
|
link:https://groups.google.com/forum/#!forum/repo-discuss[mailing list,role=external,window=_blank].
|
||||||
|
|
||||||
GERRIT
|
GERRIT
|
||||||
------
|
------
|
||||||
|
@ -15,7 +15,7 @@ already submitted and merged you may want to push your commit as a
|
|||||||
new change. To do this you have to remove the Change-Id from the
|
new change. To do this you have to remove the Change-Id from the
|
||||||
commit message as explained link:error-push-fails-due-to-commit-message.html[here] and ideally generate a new Change-Id
|
commit message as explained link:error-push-fails-due-to-commit-message.html[here] and ideally generate a new Change-Id
|
||||||
using the link:cmd-hook-commit-msg.html[commit hook] or EGit. Before pushing again it is also
|
using the link:cmd-hook-commit-msg.html[commit hook] or EGit. Before pushing again it is also
|
||||||
recommended to do a link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[git rebase] to base your commit on the submitted
|
recommended to do a link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[git rebase,role=external,window=_blank] to base your commit on the submitted
|
||||||
change. Pushing again should now create a new change in Gerrit.
|
change. Pushing again should now create a new change in Gerrit.
|
||||||
|
|
||||||
If the change for which you wanted to upload a new patch set was
|
If the change for which you wanted to upload a new patch set was
|
||||||
|
@ -8,7 +8,7 @@ To be picked up by Gerrit, a Change-Id must be in the last paragraph
|
|||||||
of a commit message. For details, see link:user-changeid.html[Change-Id Lines].
|
of a commit message. For details, see link:user-changeid.html[Change-Id Lines].
|
||||||
|
|
||||||
You can see the commit messages for existing commits in the history
|
You can see the commit messages for existing commits in the history
|
||||||
by doing a link:http://www.kernel.org/pub/software/scm/git/docs/git-log.html[git log].
|
by doing a link:http://www.kernel.org/pub/software/scm/git/docs/git-log.html[git log,role=external,window=_blank].
|
||||||
|
|
||||||
|
|
||||||
== Change-Id is contained in the commit message but not in the last paragraph
|
== Change-Id is contained in the commit message but not in the last paragraph
|
||||||
|
@ -11,7 +11,7 @@ repository again by rejecting every push of such a commit with the
|
|||||||
error message "contains banned commit ...".
|
error message "contains banned commit ...".
|
||||||
|
|
||||||
If you have commits that you want to push that are based on a banned
|
If you have commits that you want to push that are based on a banned
|
||||||
commit you may want to link:http://www.kernel.org/pub/software/scm/git/docs/git-cherry-pick.html[cherry-pick] them onto a clean base and push
|
commit you may want to link:http://www.kernel.org/pub/software/scm/git/docs/git-cherry-pick.html[cherry-pick,role=external,window=_blank] them onto a clean base and push
|
||||||
them again.
|
them again.
|
||||||
|
|
||||||
|
|
||||||
|
@ -10,7 +10,7 @@ Every change is expected to have an unique Change-Id.
|
|||||||
|
|
||||||
Since this error should never occur in practice, you should inform
|
Since this error should never occur in practice, you should inform
|
||||||
your Gerrit administrator if you hit this problem and/or
|
your Gerrit administrator if you hit this problem and/or
|
||||||
link:https://bugs.chromium.org/p/gerrit/issues/list[open a Gerrit issue].
|
link:https://bugs.chromium.org/p/gerrit/issues/list[open a Gerrit issue,role=external,window=_blank].
|
||||||
|
|
||||||
In any case to not be blocked with your work, you can simply create a
|
In any case to not be blocked with your work, you can simply create a
|
||||||
new Change-Id for your commit and then push it as new change to
|
new Change-Id for your commit and then push it as new change to
|
||||||
|
@ -121,7 +121,7 @@ update the author for the last 3 commits:
|
|||||||
----
|
----
|
||||||
|
|
||||||
For further details about git rebase please check the
|
For further details about git rebase please check the
|
||||||
link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[Git documentation].
|
link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[Git documentation,role=external,window=_blank].
|
||||||
|
|
||||||
|
|
||||||
== Missing privileges to push commits of other users
|
== Missing privileges to push commits of other users
|
||||||
|
@ -4,7 +4,7 @@ With this error message Gerrit rejects to push a commit if its commit
|
|||||||
message footer contains an invalid Change-Id line.
|
message footer contains an invalid Change-Id line.
|
||||||
|
|
||||||
You can see the commit messages for existing commits in the history
|
You can see the commit messages for existing commits in the history
|
||||||
by doing a link:http://www.kernel.org/pub/software/scm/git/docs/git-log.html[git log].
|
by doing a link:http://www.kernel.org/pub/software/scm/git/docs/git-log.html[git log,role=external,window=_blank].
|
||||||
|
|
||||||
If it was the intention to rework a change and to push a new patch
|
If it was the intention to rework a change and to push a new patch
|
||||||
set, find the change in the Gerrit Web UI, copy its Change-Id line and
|
set, find the change in the Gerrit Web UI, copy its Change-Id line and
|
||||||
|
@ -86,7 +86,7 @@ the commits are rewritten (e.g. by choosing 'reword' for all these
|
|||||||
commits and then confirming all the commit messages). Just picking
|
commits and then confirming all the commit messages). Just picking
|
||||||
all the changes will not work as in this case the committer is not
|
all the changes will not work as in this case the committer is not
|
||||||
rewritten. For further details about git rebase please check the
|
rewritten. For further details about git rebase please check the
|
||||||
link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[Git documentation].
|
link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[Git documentation,role=external,window=_blank].
|
||||||
|
|
||||||
|
|
||||||
== Missing privileges to push commits that were committed by other users
|
== Missing privileges to push commits that were committed by other users
|
||||||
|
@ -6,7 +6,7 @@ message if the commit message of the pushed commit does not contain
|
|||||||
a Change-Id.
|
a Change-Id.
|
||||||
|
|
||||||
You can see the commit messages for existing commits in the history
|
You can see the commit messages for existing commits in the history
|
||||||
by doing a link:http://www.kernel.org/pub/software/scm/git/docs/git-log.html[git log].
|
by doing a link:http://www.kernel.org/pub/software/scm/git/docs/git-log.html[git log,role=external,window=_blank].
|
||||||
|
|
||||||
To avoid this error you should use the link:cmd-hook-commit-msg.html[commit hook] or EGit to
|
To avoid this error you should use the link:cmd-hook-commit-msg.html[commit hook] or EGit to
|
||||||
automatically create and insert a unique Change-Id into the commit
|
automatically create and insert a unique Change-Id into the commit
|
||||||
|
@ -9,7 +9,7 @@ This error happens if the Change-Id is the only line in the commit
|
|||||||
message.
|
message.
|
||||||
|
|
||||||
You can see the commit messages for existing commits in the history
|
You can see the commit messages for existing commits in the history
|
||||||
by doing a link:http://www.kernel.org/pub/software/scm/git/docs/git-log.html[git log].
|
by doing a link:http://www.kernel.org/pub/software/scm/git/docs/git-log.html[git log,role=external,window=_blank].
|
||||||
|
|
||||||
== Change-Id is the only line in the commit message
|
== Change-Id is the only line in the commit message
|
||||||
|
|
||||||
|
@ -4,7 +4,7 @@ With this error message Gerrit rejects to push a commit if the commit
|
|||||||
message footer of the pushed commit contains several Change-Id lines.
|
message footer of the pushed commit contains several Change-Id lines.
|
||||||
|
|
||||||
You can see the commit messages for existing commits in the history
|
You can see the commit messages for existing commits in the history
|
||||||
by doing a link:http://www.kernel.org/pub/software/scm/git/docs/git-log.html[git log].
|
by doing a link:http://www.kernel.org/pub/software/scm/git/docs/git-log.html[git log,role=external,window=_blank].
|
||||||
|
|
||||||
If it was the intention to rework a change and to push a new patch
|
If it was the intention to rework a change and to push a new patch
|
||||||
set, find the change in the Gerrit Web UI, copy its Change-Id line and
|
set, find the change in the Gerrit Web UI, copy its Change-Id line and
|
||||||
|
@ -38,7 +38,7 @@ means:
|
|||||||
in the Gerrit Web UI will not find any change)
|
in the Gerrit Web UI will not find any change)
|
||||||
|
|
||||||
If you need to re-push a commit you may rewrite this commit by
|
If you need to re-push a commit you may rewrite this commit by
|
||||||
link:http://www.kernel.org/pub/software/scm/git/docs/git-commit.html[amending] it or doing an interactive link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[git rebase]. By rewriting the
|
link:http://www.kernel.org/pub/software/scm/git/docs/git-commit.html[amending,role=external,window=_blank] it or doing an interactive link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[git rebase,role=external,window=_blank]. By rewriting the
|
||||||
commit you actually create a new commit (with a new commit ID in
|
commit you actually create a new commit (with a new commit ID in
|
||||||
project scope) which can then be pushed to Gerrit.
|
project scope) which can then be pushed to Gerrit.
|
||||||
|
|
||||||
|
@ -28,8 +28,8 @@ remote branch evolves. If you are now pushing your commit, with
|
|||||||
bypassing code review, your push will be rejected with the error
|
bypassing code review, your push will be rejected with the error
|
||||||
message 'non-fast forward'. To solve the problem you have to either
|
message 'non-fast forward'. To solve the problem you have to either
|
||||||
|
|
||||||
. link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[rebase] your commit on the new tip of the remote branch or
|
. link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[rebase,role=external,window=_blank] your commit on the new tip of the remote branch or
|
||||||
. link:http://www.kernel.org/pub/software/scm/git/docs/git-merge.html[merge] your commit with the new tip of the remote branch.
|
. link:http://www.kernel.org/pub/software/scm/git/docs/git-merge.html[merge,role=external,window=_blank] your commit with the new tip of the remote branch.
|
||||||
|
|
||||||
Afterwards the push should be successful.
|
Afterwards the push should be successful.
|
||||||
|
|
||||||
@ -46,7 +46,7 @@ the commit to the correct project.
|
|||||||
Although it is considered bad practice, it is possible to allow
|
Although it is considered bad practice, it is possible to allow
|
||||||
non-fast forward updates with Git. For this the remote Git repository
|
non-fast forward updates with Git. For this the remote Git repository
|
||||||
has to be configured to not deny non-fast forward updates (set the
|
has to be configured to not deny non-fast forward updates (set the
|
||||||
link:http://www.kernel.org/pub/software/scm/git/docs/git-config.html[Git configuration] parameter 'receive.denyNonFastForwards' to
|
link:http://www.kernel.org/pub/software/scm/git/docs/git-config.html[Git configuration,role=external,window=_blank] parameter 'receive.denyNonFastForwards' to
|
||||||
'false'). Then it is possible to push a non-fast forward update by
|
'false'). Then it is possible to push a non-fast forward update by
|
||||||
using the '--force' option.
|
using the '--force' option.
|
||||||
|
|
||||||
|
@ -12,7 +12,7 @@ for this project.
|
|||||||
If one of your changes could not be merged in Gerrit due to conflicts
|
If one of your changes could not be merged in Gerrit due to conflicts
|
||||||
and you created the merge commit to resolve the conflicts, you might
|
and you created the merge commit to resolve the conflicts, you might
|
||||||
want to revert the merge and instead of this do a
|
want to revert the merge and instead of this do a
|
||||||
link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[rebase].
|
link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[rebase,role=external,window=_blank].
|
||||||
|
|
||||||
|
|
||||||
GERRIT
|
GERRIT
|
||||||
|
@ -3,8 +3,8 @@
|
|||||||
With this error message an SSH command to Gerrit is rejected if the
|
With this error message an SSH command to Gerrit is rejected if the
|
||||||
SSH authentication is not successful.
|
SSH authentication is not successful.
|
||||||
|
|
||||||
The link:http://en.wikipedia.org/wiki/Secure_Shell[SSH] protocol can use
|
The link:http://en.wikipedia.org/wiki/Secure_Shell[SSH,role=external,window=_blank] protocol can use
|
||||||
link:http://en.wikipedia.org/wiki/Public-key_cryptography[Public-key Cryptography]
|
link:http://en.wikipedia.org/wiki/Public-key_cryptography[Public-key Cryptography,role=external,window=_blank]
|
||||||
for authentication.
|
for authentication.
|
||||||
In general configurations, Gerrit will authenticate you by the public keys
|
In general configurations, Gerrit will authenticate you by the public keys
|
||||||
known to you. Optionally, it can be configured by the administrator to allow
|
known to you. Optionally, it can be configured by the administrator to allow
|
||||||
|
@ -6,7 +6,7 @@ the problem can often be resolved by fixing the commit message.
|
|||||||
|
|
||||||
If the commit message of the last commit needs to be fixed you can
|
If the commit message of the last commit needs to be fixed you can
|
||||||
simply amend the last commit (please find a detailed description in
|
simply amend the last commit (please find a detailed description in
|
||||||
the link:http://www.kernel.org/pub/software/scm/git/docs/git-commit.html[Git documentation]):
|
the link:http://www.kernel.org/pub/software/scm/git/docs/git-commit.html[Git documentation,role=external,window=_blank]):
|
||||||
|
|
||||||
----
|
----
|
||||||
$ git commit --amend
|
$ git commit --amend
|
||||||
@ -17,7 +17,7 @@ commit other than the last one you have to do an interactive git
|
|||||||
rebase for the affected commits. While doing the interactive rebase
|
rebase for the affected commits. While doing the interactive rebase
|
||||||
you can e.g. choose 'reword' for those commits for which you want to
|
you can e.g. choose 'reword' for those commits for which you want to
|
||||||
fix the commit messages. For a detailed description of git rebase
|
fix the commit messages. For a detailed description of git rebase
|
||||||
please check the link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[Git documentation].
|
please check the link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[Git documentation,role=external,window=_blank].
|
||||||
|
|
||||||
Please use interactive git rebase with care as it rewrites existing
|
Please use interactive git rebase with care as it rewrites existing
|
||||||
commits. Generally you should never rewrite commits that have already
|
commits. Generally you should never rewrite commits that have already
|
||||||
|
@ -64,7 +64,7 @@ To squash the commits, use `git rebase -i` to do an interactive rebase. For
|
|||||||
the example above where the last two commits have the same Change-Id,
|
the example above where the last two commits have the same Change-Id,
|
||||||
this means an interactive rebase for the last two commits should be
|
this means an interactive rebase for the last two commits should be
|
||||||
done. For further details about the git rebase command please check
|
done. For further details about the git rebase command please check
|
||||||
the link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[Git documentation for rebase].
|
the link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[Git documentation for rebase,role=external,window=_blank].
|
||||||
|
|
||||||
----
|
----
|
||||||
$ git rebase -i HEAD~2
|
$ git rebase -i HEAD~2
|
||||||
@ -100,7 +100,7 @@ Gerrit does not exist yet, the Change-Id should be generated (either
|
|||||||
by using a link:cmd-hook-commit-msg.html[commit hook] or by using EGit) or the Change-Id could be
|
by using a link:cmd-hook-commit-msg.html[commit hook] or by using EGit) or the Change-Id could be
|
||||||
removed (not recommended since then amending this commit to create
|
removed (not recommended since then amending this commit to create
|
||||||
subsequent patch sets is more error prone). To change the Change-Id
|
subsequent patch sets is more error prone). To change the Change-Id
|
||||||
of an existing commit do an interactive link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[git rebase] and fix the
|
of an existing commit do an interactive link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[git rebase,role=external,window=_blank] and fix the
|
||||||
affected commit messages.
|
affected commit messages.
|
||||||
|
|
||||||
|
|
||||||
|
@ -9,7 +9,7 @@ There are two possibilities how to continue in this situation:
|
|||||||
. contact one of the project owners and request upload permissions
|
. contact one of the project owners and request upload permissions
|
||||||
for the project (access right
|
for the project (access right
|
||||||
link:access-control.html#category_push['Push'])
|
link:access-control.html#category_push['Push'])
|
||||||
. export your commit as a patch using the link:http://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html[git format-patch] command
|
. export your commit as a patch using the link:http://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html[git format-patch,role=external,window=_blank] command
|
||||||
and provide the patch file to one of the project owners
|
and provide the patch file to one of the project owners
|
||||||
|
|
||||||
|
|
||||||
|
@ -16,7 +16,7 @@
|
|||||||
== Guides
|
== Guides
|
||||||
. link:intro-user.html[User Guide]
|
. link:intro-user.html[User Guide]
|
||||||
. link:intro-project-owner.html[Project Owner Guide]
|
. link:intro-project-owner.html[Project Owner Guide]
|
||||||
. link:https://source.android.com/source/developing[Default Android Workflow] (external)
|
. link:https://source.android.com/source/developing[Default Android Workflow,role=external,window=_blank] (external)
|
||||||
|
|
||||||
== Tutorials
|
== Tutorials
|
||||||
. Web
|
. Web
|
||||||
@ -43,7 +43,7 @@
|
|||||||
. link:access-control.html[Access Controls]
|
. link:access-control.html[Access Controls]
|
||||||
. Multi-project management
|
. Multi-project management
|
||||||
.. link:user-submodules.html[Submodules]
|
.. link:user-submodules.html[Submodules]
|
||||||
.. link:https://source.android.com/source/using-repo.html[Repo] (external)
|
.. link:https://source.android.com/source/using-repo.html[Repo,role=external,window=_blank] (external)
|
||||||
. Prolog rules
|
. Prolog rules
|
||||||
.. link:prolog-cookbook.html[Prolog Cookbook]
|
.. link:prolog-cookbook.html[Prolog Cookbook]
|
||||||
.. link:prolog-change-facts.html[Prolog Facts for Gerrit Changes]
|
.. link:prolog-change-facts.html[Prolog Facts for Gerrit Changes]
|
||||||
@ -84,11 +84,11 @@
|
|||||||
|
|
||||||
== Resources
|
== Resources
|
||||||
* link:licenses.html[Licenses and Notices]
|
* link:licenses.html[Licenses and Notices]
|
||||||
* link:https://www.gerritcodereview.com/[Homepage]
|
* link:https://www.gerritcodereview.com/[Homepage,role=external,window=_blank]
|
||||||
* link:https://gerrit-releases.storage.googleapis.com/index.html[Downloads]
|
* link:https://gerrit-releases.storage.googleapis.com/index.html[Downloads,role=external,window=_blank]
|
||||||
* link:https://bugs.chromium.org/p/gerrit/issues/list[Issue Tracking]
|
* link:https://bugs.chromium.org/p/gerrit/issues/list[Issue Tracking,role=external,window=_blank]
|
||||||
* link:https://gerrit.googlesource.com/gerrit[Source Code]
|
* link:https://gerrit.googlesource.com/gerrit[Source Code,role=external,window=_blank]
|
||||||
* link:https://www.gerritcodereview.com/about.md[A History of Gerrit Code Review]
|
* link:https://www.gerritcodereview.com/about.md[A History of Gerrit Code Review,role=external,window=_blank]
|
||||||
|
|
||||||
GERRIT
|
GERRIT
|
||||||
------
|
------
|
||||||
|
@ -47,7 +47,7 @@ directly to change 4543.
|
|||||||
Download and unzip a release version of Jetty. From here on we
|
Download and unzip a release version of Jetty. From here on we
|
||||||
call the unpacked directory `$JETTY_HOME`.
|
call the unpacked directory `$JETTY_HOME`.
|
||||||
|
|
||||||
* link:http://www.eclipse.org/jetty/downloads.php[Jetty Downloads]
|
* link:http://www.eclipse.org/jetty/downloads.php[Jetty Downloads,role=external,window=_blank]
|
||||||
|
|
||||||
If this is a fresh installation of Jetty, move into the installation
|
If this is a fresh installation of Jetty, move into the installation
|
||||||
directory and do some cleanup to remove the sample webapps:
|
directory and do some cleanup to remove the sample webapps:
|
||||||
@ -99,7 +99,7 @@ slashes]. Otherwise Tomcat must be configured to encode slashes, by adding
|
|||||||
|
|
||||||
Excerpt from the
|
Excerpt from the
|
||||||
link:https://tomcat.apache.org/tomcat-7.0-doc/config/systemprops.html[
|
link:https://tomcat.apache.org/tomcat-7.0-doc/config/systemprops.html[
|
||||||
documentation]:
|
documentation,role=external,window=_blank]:
|
||||||
|
|
||||||
----
|
----
|
||||||
Property org.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH:
|
Property org.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH:
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
|
|
||||||
To run the Gerrit service, the following requirement must be met on the host:
|
To run the Gerrit service, the following requirement must be met on the host:
|
||||||
|
|
||||||
* JRE, version 1.8 http://www.oracle.com/technetwork/java/javase/downloads/index.html[Download]
|
* JRE, version 1.8 http://www.oracle.com/technetwork/java/javase/downloads/index.html[Download,role=external,window=_blank]
|
||||||
+
|
+
|
||||||
Gerrit is not yet compatible with Java 9 or newer at this time.
|
Gerrit is not yet compatible with Java 9 or newer at this time.
|
||||||
|
|
||||||
@ -22,8 +22,8 @@ Installing JCE extensions is optional and export restrictions may apply.
|
|||||||
|
|
||||||
. Download the unlimited strength JCE policy files.
|
. Download the unlimited strength JCE policy files.
|
||||||
+
|
+
|
||||||
- link:http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html[JDK7 JCE policy files]
|
- link:http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html[JDK7 JCE policy files,role=external,window=_blank]
|
||||||
- link:http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html[JDK8 JCE policy files]
|
- link:http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html[JDK8 JCE policy files,role=external,window=_blank]
|
||||||
. Uncompress and extract the downloaded file.
|
. Uncompress and extract the downloaded file.
|
||||||
+
|
+
|
||||||
The downloaded file contains the following files:
|
The downloaded file contains the following files:
|
||||||
@ -47,7 +47,7 @@ found in `README.txt`.
|
|||||||
|
|
||||||
Current and past binary releases of Gerrit can be obtained from
|
Current and past binary releases of Gerrit can be obtained from
|
||||||
the link:https://gerrit-releases.storage.googleapis.com/index.html[
|
the link:https://gerrit-releases.storage.googleapis.com/index.html[
|
||||||
Gerrit Releases site].
|
Gerrit Releases site,role=external,window=_blank].
|
||||||
|
|
||||||
Download any current `*.war` package. The war will be referred to as
|
Download any current `*.war` package. The war will be referred to as
|
||||||
`gerrit.war` from this point forward, so you may find it easier to
|
`gerrit.war` from this point forward, so you may find it easier to
|
||||||
@ -173,7 +173,7 @@ link:install-j2ee.html[J2EE installation].
|
|||||||
|
|
||||||
The `ssh-keygen` command must be available during the init phase to
|
The `ssh-keygen` command must be available during the init phase to
|
||||||
generate SSH host keys. If you have
|
generate SSH host keys. If you have
|
||||||
link:https://git-for-windows.github.io/[Git for Windows] installed,
|
link:https://git-for-windows.github.io/[Git for Windows,role=external,window=_blank] installed,
|
||||||
start Command Prompt and temporary add directory with ssh-keygen to the
|
start Command Prompt and temporary add directory with ssh-keygen to the
|
||||||
PATH environment variable just before running init command:
|
PATH environment variable just before running init command:
|
||||||
|
|
||||||
@ -197,7 +197,7 @@ To stop the daemon press Ctrl+C.
|
|||||||
|
|
||||||
To install Gerrit as Windows Service use the
|
To install Gerrit as Windows Service use the
|
||||||
link:http://commons.apache.org/proper/commons-daemon/procrun.html[Apache
|
link:http://commons.apache.org/proper/commons-daemon/procrun.html[Apache
|
||||||
Commons Daemon Procrun].
|
Commons Daemon Procrun,role=external,window=_blank].
|
||||||
|
|
||||||
Sample install command:
|
Sample install command:
|
||||||
|
|
||||||
@ -235,7 +235,7 @@ anonymous, unencrypted git:// protocol is more efficient than
|
|||||||
Gerrit's internal SSH daemon. See the `git-daemon` documentation
|
Gerrit's internal SSH daemon. See the `git-daemon` documentation
|
||||||
for details on how to configure this if anonymous access is desired.
|
for details on how to configure this if anonymous access is desired.
|
||||||
|
|
||||||
* http://www.kernel.org/pub/software/scm/git/docs/git-daemon.html[man git-daemon]
|
* http://www.kernel.org/pub/software/scm/git/docs/git-daemon.html[man git-daemon,role=external,window=_blank]
|
||||||
|
|
||||||
|
|
||||||
[[plugins]]
|
[[plugins]]
|
||||||
@ -246,7 +246,7 @@ Place Gerrit plugins in the review_site/plugins directory to have them loaded on
|
|||||||
|
|
||||||
== External Documentation Links
|
== External Documentation Links
|
||||||
|
|
||||||
* http://www.kernel.org/pub/software/scm/git/docs/git-daemon.html[git-daemon]
|
* http://www.kernel.org/pub/software/scm/git/docs/git-daemon.html[git-daemon,role=external,window=_blank]
|
||||||
|
|
||||||
|
|
||||||
[[backup]]
|
[[backup]]
|
||||||
|
@ -25,7 +25,7 @@ Here’s how getting code reviewed and submitted with Gerrit is different from
|
|||||||
doing the same with GitHub:
|
doing the same with GitHub:
|
||||||
|
|
||||||
* You need the add a commit-msg hook script when you clone a repo for the first
|
* You need the add a commit-msg hook script when you clone a repo for the first
|
||||||
time using a snippet you can find e.g. https://gerrit-review.googlesource.com/admin/repos/gerrit[here];
|
time using a snippet you can find e.g. https://gerrit-review.googlesource.com/admin/repos/gerrit[here,role=external,window=_blank];
|
||||||
* Your review will be on a single commit instead of a branch. You use
|
* Your review will be on a single commit instead of a branch. You use
|
||||||
`git commit --amend` to modify a code change.
|
`git commit --amend` to modify a code change.
|
||||||
* Instead of using the Web UI to create a pull request, you use
|
* Instead of using the Web UI to create a pull request, you use
|
||||||
@ -54,11 +54,11 @@ The first step to working with the code is to clone the repo. For both, Gerrit
|
|||||||
and GitHub, you can simply use the `git clone` command.
|
and GitHub, you can simply use the `git clone` command.
|
||||||
|
|
||||||
For Gerrit, there is an additional step before you can start making changes. For
|
For Gerrit, there is an additional step before you can start making changes. For
|
||||||
reasons we explain below, you’ll have to add a https://gerrit-review.googlesource.com/Documentation/user-changeid.html[commit-msg hook] script. This will
|
reasons we explain below, you’ll have to add a https://gerrit-review.googlesource.com/Documentation/user-changeid.html[commit-msg hook,role=external,window=_blank] script. This will
|
||||||
append the Gerrit Change-Id to every commit message such that Gerrit can track
|
append the Gerrit Change-Id to every commit message such that Gerrit can track
|
||||||
commits through the review process. To make this process a little easier in
|
commits through the review process. To make this process a little easier in
|
||||||
Gerrit, you can find a command snippet for cloning and adding the commit-msg
|
Gerrit, you can find a command snippet for cloning and adding the commit-msg
|
||||||
hook on the repository page (e.g. https://gerrit-review.googlesource.com/admin/repos/gerrit[here]).
|
hook on the repository page (e.g. https://gerrit-review.googlesource.com/admin/repos/gerrit[here,role=external,window=_blank]).
|
||||||
|
|
||||||
[[create-change]]
|
[[create-change]]
|
||||||
== 2. Making a Change
|
== 2. Making a Change
|
||||||
@ -141,7 +141,7 @@ any way. You can also see all changes on a Gerrit server by using the top menu
|
|||||||
(“Changes” -> “Open”). This view is more similar to what you see on Github, when
|
(“Changes” -> “Open”). This view is more similar to what you see on Github, when
|
||||||
you navigate to the Pull Requests tab of the project/repository you are working
|
you navigate to the Pull Requests tab of the project/repository you are working
|
||||||
on. Note, however, that a single Gerrit instance can host multiple projects
|
on. Note, however, that a single Gerrit instance can host multiple projects
|
||||||
(also referred to as repositories; a list can be found, for example, https://gerrit-review.googlesource.com/admin/repos[here]). Your
|
(also referred to as repositories; a list can be found, for example, https://gerrit-review.googlesource.com/admin/repos[here,role=external,window=_blank]). Your
|
||||||
dashboard and other lists of changes will show all changes across the
|
dashboard and other lists of changes will show all changes across the
|
||||||
projects/repositories by default.
|
projects/repositories by default.
|
||||||
|
|
||||||
@ -191,7 +191,7 @@ need to make a few updates to the code in your change. As mentioned in Section 2
|
|||||||
on. To do that, you might have to checkout the respective commit first if it is
|
on. To do that, you might have to checkout the respective commit first if it is
|
||||||
not at the tip of your local branch, for example if you stacked multiple changes
|
not at the tip of your local branch, for example if you stacked multiple changes
|
||||||
on top of each other. Another common use case is to not have a local branch but
|
on top of each other. Another common use case is to not have a local branch but
|
||||||
to work in the so-called https://www.git-tower.com/learn/git/faq/detached-head-when-checkout-commit["detached HEAD"] mode. In that case you can use the
|
to work in the so-called https://www.git-tower.com/learn/git/faq/detached-head-when-checkout-commit["detached HEAD",role=external,window=_blank] mode. In that case you can use the
|
||||||
“Download” button on the files tab to copy a command that fetches and checks out
|
“Download” button on the files tab to copy a command that fetches and checks out
|
||||||
the commit underlying your change. Make sure to select the latest patchset,
|
the commit underlying your change. Make sure to select the latest patchset,
|
||||||
though!
|
though!
|
||||||
|
@ -130,7 +130,7 @@ In general, the *Code-Review* check requires an individual to look at the code,
|
|||||||
while the *Verified* check is done by an automated build server, through a
|
while the *Verified* check is done by an automated build server, through a
|
||||||
mechanism such as the
|
mechanism such as the
|
||||||
link:https://wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger[Gerrit Trigger
|
link:https://wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger[Gerrit Trigger
|
||||||
Jenkins Plugin].
|
Jenkins Plugin,role=external,window=_blank].
|
||||||
|
|
||||||
IMPORTANT: The Code-Review and Verified checks require different permissions
|
IMPORTANT: The Code-Review and Verified checks require different permissions
|
||||||
in Gerrit. This requirement allows teams to separate these tasks. For example,
|
in Gerrit. This requirement allows teams to separate these tasks. For example,
|
||||||
@ -252,7 +252,7 @@ NOTE: Remember that this walkthrough uses Gerrit's default workflow. Projects
|
|||||||
can add custom checks or even remove the Verified check entirely.
|
can add custom checks or even remove the Verified check entirely.
|
||||||
|
|
||||||
Verification is typically an automated process using the
|
Verification is typically an automated process using the
|
||||||
link:https://wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger[Gerrit Trigger Jenkins Plugin]
|
link:https://wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger[Gerrit Trigger Jenkins Plugin,role=external,window=_blank]
|
||||||
or a similar mechanism. However, there are still times when a change requires
|
or a similar mechanism. However, there are still times when a change requires
|
||||||
manual verification, or a reviewer needs to check how or if a change works.
|
manual verification, or a reviewer needs to check how or if a change works.
|
||||||
To accommodate these and other similar circumstances, Gerrit exposes each change
|
To accommodate these and other similar circumstances, Gerrit exposes each change
|
||||||
|
@ -181,7 +181,7 @@ them, e.g. link:access-control.html#ldap_groups[LDAP group names] need
|
|||||||
to be prefixed with `ldap/`.
|
to be prefixed with `ldap/`.
|
||||||
|
|
||||||
If the link:https://gerrit-review.googlesource.com/admin/repos/plugins/singleusergroup[
|
If the link:https://gerrit-review.googlesource.com/admin/repos/plugins/singleusergroup[
|
||||||
singleusergroup] plugin is installed you can also directly assign
|
singleusergroup,role=external,window=_blank] plugin is installed you can also directly assign
|
||||||
access rights to users, by prefixing the username with `user/` or the
|
access rights to users, by prefixing the username with `user/` or the
|
||||||
user's account ID by `userid/`.
|
user's account ID by `userid/`.
|
||||||
|
|
||||||
@ -374,10 +374,10 @@ There are several solutions for integrating continuous integration
|
|||||||
systems. The most commonly used are:
|
systems. The most commonly used are:
|
||||||
|
|
||||||
- link:https://wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger[
|
- link:https://wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger[
|
||||||
Gerrit Trigger] plugin for link:http://jenkins-ci.org/[Jenkins]
|
Gerrit Trigger,role=external,window=_blank] plugin for link:http://jenkins-ci.org/[Jenkins,role=external,window=_blank]
|
||||||
|
|
||||||
- link:http://www.mediawiki.org/wiki/Continuous_integration/Zuul[
|
- link:http://www.mediawiki.org/wiki/Continuous_integration/Zuul[
|
||||||
Zuul] for link:http://jenkins-ci.org/[Jenkins]
|
Zuul,role=external,window=_blank] for link:http://jenkins-ci.org/[Jenkins,role=external,window=_blank]
|
||||||
|
|
||||||
For the integration with the continuous integration system you must
|
For the integration with the continuous integration system you must
|
||||||
have a service user that is able to access Gerrit. To create a service
|
have a service user that is able to access Gerrit. To create a service
|
||||||
@ -387,7 +387,7 @@ Create Account] global capability is granted. If not, you need to ask
|
|||||||
a Gerrit administrator to create the service user.
|
a Gerrit administrator to create the service user.
|
||||||
|
|
||||||
If the link:https://gerrit-review.googlesource.com/admin/repos/plugins/serviceuser[
|
If the link:https://gerrit-review.googlesource.com/admin/repos/plugins/serviceuser[
|
||||||
serviceuser] plugin is installed you can also create new service users
|
serviceuser,role=external,window=_blank] plugin is installed you can also create new service users
|
||||||
in the Gerrit Web UI under `People` > `Create Service User`. For this
|
in the Gerrit Web UI under `People` > `Create Service User`. For this
|
||||||
the `Create Service User` global capability must be assigned.
|
the `Create Service User` global capability must be assigned.
|
||||||
|
|
||||||
@ -407,7 +407,7 @@ capability assigned.
|
|||||||
|
|
||||||
Gerrit provides an
|
Gerrit provides an
|
||||||
link:https://gerrit-review.googlesource.com/Documentation/config-validation.html#new-commit-validation[
|
link:https://gerrit-review.googlesource.com/Documentation/config-validation.html#new-commit-validation[
|
||||||
extension point to do validation of new commits]. A Gerrit plugin
|
extension point to do validation of new commits,role=external,window=_blank]. A Gerrit plugin
|
||||||
implementing this extension point can perform validation checks when
|
implementing this extension point can perform validation checks when
|
||||||
new commits are pushed to Gerrit. The plugin can either provide a
|
new commits are pushed to Gerrit. The plugin can either provide a
|
||||||
message to the client or reject the commit and cause the push to fail.
|
message to the client or reject the commit and cause the push to fail.
|
||||||
@ -415,13 +415,13 @@ message to the client or reject the commit and cause the push to fail.
|
|||||||
There are some plugins available that provide commit validation:
|
There are some plugins available that provide commit validation:
|
||||||
|
|
||||||
- link:https://gerrit-review.googlesource.com/admin/repos/plugins/uploadvalidator[
|
- link:https://gerrit-review.googlesource.com/admin/repos/plugins/uploadvalidator[
|
||||||
uploadvalidator]:
|
uploadvalidator,role=external,window=_blank]:
|
||||||
+
|
+
|
||||||
The `uploadvalidator` plugin allows project owners to configure blocked
|
The `uploadvalidator` plugin allows project owners to configure blocked
|
||||||
file extensions, required footers and a maximum allowed path length.
|
file extensions, required footers and a maximum allowed path length.
|
||||||
|
|
||||||
- link:https://gerrit-review.googlesource.com/admin/repos/plugins/commit-message-length-validator[
|
- link:https://gerrit-review.googlesource.com/admin/repos/plugins/commit-message-length-validator[
|
||||||
commit-message-length-validator]
|
commit-message-length-validator,role=external,window=_blank]
|
||||||
+
|
+
|
||||||
The `commit-message-length-validator` core plugin validates that commit
|
The `commit-message-length-validator` core plugin validates that commit
|
||||||
messages conform to line length limits.
|
messages conform to line length limits.
|
||||||
@ -501,9 +501,9 @@ only be done globally by a Gerrit administrator.
|
|||||||
- Issue Tracker System Plugins
|
- Issue Tracker System Plugins
|
||||||
+
|
+
|
||||||
There are Gerrit plugins for a tight integration with
|
There are Gerrit plugins for a tight integration with
|
||||||
link:https://gerrit-review.googlesource.com//admin/repos/plugins/its-jira[Jira],
|
link:https://gerrit-review.googlesource.com//admin/repos/plugins/its-jira[Jira,role=external,window=_blank],
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/its-bugzilla[Bugzilla] and
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/its-bugzilla[Bugzilla,role=external,window=_blank] and
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/its-rtc[IBM Rational Team Concert].
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/its-rtc[IBM Rational Team Concert,role=external,window=_blank].
|
||||||
If installed, these plugins can e.g. be used to automatically add links
|
If installed, these plugins can e.g. be used to automatically add links
|
||||||
to Gerrit changes to the issues in the issue tracker system or to
|
to Gerrit changes to the issues in the issue tracker system or to
|
||||||
automatically close an issue if the corresponding change is merged.
|
automatically close an issue if the corresponding change is merged.
|
||||||
@ -551,15 +551,15 @@ by adding this person in the Gerrit Web UI as a reviewer on the change.
|
|||||||
Gerrit will then notify this person by email about the review request.
|
Gerrit will then notify this person by email about the review request.
|
||||||
|
|
||||||
With the link:https://gerrit-review.googlesource.com/admin/repos/plugins/reviewers[
|
With the link:https://gerrit-review.googlesource.com/admin/repos/plugins/reviewers[
|
||||||
reviewers] plugin it is possible to configure default reviewers who
|
reviewers,role=external,window=_blank] plugin it is possible to configure default reviewers who
|
||||||
will be automatically added to each change. The default reviewers can
|
will be automatically added to each change. The default reviewers can
|
||||||
be configured in the Gerrit Web UI under `Projects` > `List` >
|
be configured in the Gerrit Web UI under `Projects` > `List` >
|
||||||
<your project> > `General` in the `reviewers Plugin` section.
|
<your project> > `General` in the `reviewers Plugin` section.
|
||||||
|
|
||||||
The link:https://gerrit-review.googlesource.com/admin/repos/plugins/reviewers-by-blame[
|
The link:https://gerrit-review.googlesource.com/admin/repos/plugins/reviewers-by-blame[
|
||||||
reviewers-by-blame] plugin can automatically add reviewers to changes
|
reviewers-by-blame,role=external,window=_blank] plugin can automatically add reviewers to changes
|
||||||
based on the link:https://www.kernel.org/pub/software/scm/git/docs/git-blame.html[
|
based on the link:https://www.kernel.org/pub/software/scm/git/docs/git-blame.html[
|
||||||
git blame] computation on the changed files. This means that the plugin
|
git blame,role=external,window=_blank] computation on the changed files. This means that the plugin
|
||||||
will add those users as reviewer that authored most of the lines
|
will add those users as reviewer that authored most of the lines
|
||||||
touched by the change, since these users should be familiar with the
|
touched by the change, since these users should be familiar with the
|
||||||
code and can most likely review the change. How many reviewers the
|
code and can most likely review the change. How many reviewers the
|
||||||
@ -578,7 +578,7 @@ that the available download commands depend on the installed Gerrit
|
|||||||
plugins:
|
plugins:
|
||||||
|
|
||||||
- link:https://gerrit-review.googlesource.com/admin/repos/plugins/download-commands[
|
- link:https://gerrit-review.googlesource.com/admin/repos/plugins/download-commands[
|
||||||
download-commands] plugin:
|
download-commands,role=external,window=_blank] plugin:
|
||||||
+
|
+
|
||||||
The `download-commands` plugin provides the default download commands
|
The `download-commands` plugin provides the default download commands
|
||||||
(`Checkout`, `Cherry Pick`, `Format Patch` and `Pull`).
|
(`Checkout`, `Cherry Pick`, `Format Patch` and `Pull`).
|
||||||
@ -587,14 +587,14 @@ Gerrit administrators may configure which of the commands are shown on
|
|||||||
the change screen.
|
the change screen.
|
||||||
|
|
||||||
- link:https://gerrit-review.googlesource.com/admin/repos/plugins/egit[
|
- link:https://gerrit-review.googlesource.com/admin/repos/plugins/egit[
|
||||||
egit] plugin:
|
egit,role=external,window=_blank] plugin:
|
||||||
+
|
+
|
||||||
The `egit` plugin provides the change ref as a download command, which is
|
The `egit` plugin provides the change ref as a download command, which is
|
||||||
needed for downloading a change from within
|
needed for downloading a change from within
|
||||||
link:https://www.eclipse.org/egit/[EGit].
|
link:https://www.eclipse.org/egit/[EGit].
|
||||||
|
|
||||||
- link:https://gerrit-review.googlesource.com/admin/repos/plugins/project-download-commands[
|
- link:https://gerrit-review.googlesource.com/admin/repos/plugins/project-download-commands[
|
||||||
project-download-commands] plugin:
|
project-download-commands,role=external,window=_blank] plugin:
|
||||||
+
|
+
|
||||||
The `project-download-commands` plugin enables project owners to
|
The `project-download-commands` plugin enables project owners to
|
||||||
configure project-specific download commands. For example, a
|
configure project-specific download commands. For example, a
|
||||||
@ -678,14 +678,14 @@ project. To do this you need to have a local Git repository that
|
|||||||
contains this history. If your existing codebase is in another VCS you
|
contains this history. If your existing codebase is in another VCS you
|
||||||
must migrate it to Git first. For Subversion you can use the
|
must migrate it to Git first. For Subversion you can use the
|
||||||
link:http://git-scm.com/book/en/Git-and-Other-Systems-Git-and-Subversion[
|
link:http://git-scm.com/book/en/Git-and-Other-Systems-Git-and-Subversion[
|
||||||
git svn] command as described in the
|
git svn,role=external,window=_blank] command as described in the
|
||||||
link:http://git-scm.com/book/en/Git-and-Other-Systems-Migrating-to-Git#Subversion[
|
link:http://git-scm.com/book/en/Git-and-Other-Systems-Migrating-to-Git#Subversion[
|
||||||
Subversion migration guide]. An importer for Perforce is available in
|
Subversion migration guide,role=external,window=_blank]. An importer for Perforce is available in
|
||||||
the `contrib` section of the Git source code; how to use
|
the `contrib` section of the Git source code; how to use
|
||||||
link:http://git-scm.com/docs/git-p4[git p4] to do the import from
|
link:http://git-scm.com/docs/git-p4[git p4,role=external,window=_blank] to do the import from
|
||||||
Perforce is described in the
|
Perforce is described in the
|
||||||
link:http://git-scm.com/book/en/Git-and-Other-Systems-Migrating-to-Git#Perforce[
|
link:http://git-scm.com/book/en/Git-and-Other-Systems-Migrating-to-Git#Perforce[
|
||||||
Perforce migration guide].
|
Perforce migration guide,role=external,window=_blank].
|
||||||
|
|
||||||
To import an existing history into a Gerrit project you bypass code
|
To import an existing history into a Gerrit project you bypass code
|
||||||
review and push it directly to `refs/heads/<branch>`. For this you must
|
review and push it directly to `refs/heads/<branch>`. For this you must
|
||||||
@ -699,7 +699,7 @@ Some Gerrit servers may disallow forging committers by blocking the
|
|||||||
link:access-control.html#category_forge_committer[Forge Committer]
|
link:access-control.html#category_forge_committer[Forge Committer]
|
||||||
access right globally. In this case you must use the
|
access right globally. In this case you must use the
|
||||||
link:https://www.kernel.org/pub/software/scm/git/docs/git-filter-branch.html[
|
link:https://www.kernel.org/pub/software/scm/git/docs/git-filter-branch.html[
|
||||||
git filter-branch] command to rewrite the committer information for all
|
git filter-branch,role=external,window=_blank] command to rewrite the committer information for all
|
||||||
commits (the author information that records who was writing the code
|
commits (the author information that records who was writing the code
|
||||||
stays intact; signed tags will lose their signature):
|
stays intact; signed tags will lose their signature):
|
||||||
|
|
||||||
@ -741,7 +741,7 @@ have been rewritten are removed.
|
|||||||
Gerrit core does not support the deletion of projects.
|
Gerrit core does not support the deletion of projects.
|
||||||
|
|
||||||
If the link:https://gerrit-review.googlesource.com/admin/repos/plugins/delete-project[
|
If the link:https://gerrit-review.googlesource.com/admin/repos/plugins/delete-project[
|
||||||
delete-project] plugin is installed, projects can be deleted from the
|
delete-project,role=external,window=_blank] plugin is installed, projects can be deleted from the
|
||||||
Gerrit Web UI under `Projects` > `List` > <project> > `General` by
|
Gerrit Web UI under `Projects` > `List` > <project> > `General` by
|
||||||
clicking on the `Delete` command under `Project Commands`. The `Delete`
|
clicking on the `Delete` command under `Project Commands`. The `Delete`
|
||||||
command is only available if you have the `Delete Projects` global
|
command is only available if you have the `Delete Projects` global
|
||||||
@ -769,7 +769,7 @@ Please note that a drawback of this workaround is that the whole review
|
|||||||
history (changes, review comments) is lost.
|
history (changes, review comments) is lost.
|
||||||
|
|
||||||
Alternatively, you can use the
|
Alternatively, you can use the
|
||||||
link:https://gerrit.googlesource.com/plugins/importer/[importer] plugin
|
link:https://gerrit.googlesource.com/plugins/importer/[importer,role=external,window=_blank] plugin
|
||||||
to copy the project _including the review history_, and then
|
to copy the project _including the review history_, and then
|
||||||
link:#project-deletion[delete the old project].
|
link:#project-deletion[delete the old project].
|
||||||
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
= Gerrit Code Review Product Overview
|
= Gerrit Code Review Product Overview
|
||||||
|
|
||||||
Gerrit Code Review is a web-based code review tool built on
|
Gerrit Code Review is a web-based code review tool built on
|
||||||
https://git-scm.com/[Git version control].
|
https://git-scm.com/[Git version control,role=external,window=_blank].
|
||||||
|
|
||||||
== What is Gerrit Code Review?
|
== What is Gerrit Code Review?
|
||||||
|
|
||||||
@ -45,7 +45,7 @@ To learn more, see:
|
|||||||
|
|
||||||
. link:intro-user.html[User Guide]
|
. link:intro-user.html[User Guide]
|
||||||
. link:intro-project-owner.html[Project Owner Guide]
|
. link:intro-project-owner.html[Project Owner Guide]
|
||||||
. link:https://source.android.com/source/life-of-a-patch[Default Android Workflow] (external)
|
. link:https://source.android.com/source/life-of-a-patch[Default Android Workflow,role=external,window=_blank] (external)
|
||||||
|
|
||||||
GERRIT
|
GERRIT
|
||||||
------
|
------
|
||||||
|
@ -42,7 +42,7 @@ functional change, as is required for:
|
|||||||
|
|
||||||
* git cherry-pick
|
* git cherry-pick
|
||||||
|
|
||||||
* link:https://www.kernel.org/pub/software/scm/git/docs/git-bisect-lk2009.html[git bisect]
|
* link:https://www.kernel.org/pub/software/scm/git/docs/git-bisect-lk2009.html[git bisect,role=external,window=_blank]
|
||||||
|
|
||||||
|
|
||||||
[[amending]]
|
[[amending]]
|
||||||
@ -59,8 +59,8 @@ older (imperfect) revision is not lost. It can be found via the `git reflog`.
|
|||||||
|
|
||||||
At least two well-known open source projects insist on these practices:
|
At least two well-known open source projects insist on these practices:
|
||||||
|
|
||||||
* link:http://git-scm.com/[Git]
|
* link:http://git-scm.com/[Git,role=external,window=_blank]
|
||||||
* link:http://www.kernel.org/category/about.html[Linux Kernel]
|
* link:http://www.kernel.org/category/about.html[Linux Kernel,role=external,window=_blank]
|
||||||
|
|
||||||
However, contributors to these projects don’t refine and polish their changes
|
However, contributors to these projects don’t refine and polish their changes
|
||||||
in private until they’re perfect. Instead, polishing code is part of a review
|
in private until they’re perfect. Instead, polishing code is part of a review
|
||||||
|
@ -4,7 +4,7 @@ This is a Gerrit guide that is dedicated to Gerrit end-users. It
|
|||||||
explains the standard Gerrit workflows and how a user can adapt Gerrit
|
explains the standard Gerrit workflows and how a user can adapt Gerrit
|
||||||
to personal preferences.
|
to personal preferences.
|
||||||
|
|
||||||
It is expected that readers know about link:http://git-scm.com/[Git]
|
It is expected that readers know about link:http://git-scm.com/[Git,role=external,window=_blank]
|
||||||
and that they are familiar with basic git commands and workflows.
|
and that they are familiar with basic git commands and workflows.
|
||||||
|
|
||||||
[[gerrit]]
|
[[gerrit]]
|
||||||
@ -21,20 +21,20 @@ link:#no-code-review[work without code review].
|
|||||||
|
|
||||||
Gerrit uses the git protocol. This means in order to work with Gerrit
|
Gerrit uses the git protocol. This means in order to work with Gerrit
|
||||||
you do *not* need to install any Gerrit client, but having a regular
|
you do *not* need to install any Gerrit client, but having a regular
|
||||||
git client, such as the link:http://git-scm.com/[git command line] or
|
git client, such as the link:http://git-scm.com/[git command line,role=external,window=_blank] or
|
||||||
link:http://eclipse.org/egit/[EGit] in Eclipse, is sufficient.
|
link:http://eclipse.org/egit/[EGit,role=external,window=_blank] in Eclipse, is sufficient.
|
||||||
|
|
||||||
Still there are some client-side tools for Gerrit, which can be used
|
Still there are some client-side tools for Gerrit, which can be used
|
||||||
optionally:
|
optionally:
|
||||||
|
|
||||||
* link:http://eclipse.org/mylyn/[Mylyn Gerrit Connector]: Gerrit
|
* link:http://eclipse.org/mylyn/[Mylyn Gerrit Connector,role=external,window=_blank]: Gerrit
|
||||||
integration with Mylyn
|
integration with Mylyn
|
||||||
* link:https://github.com/uwolfer/gerrit-intellij-plugin[Gerrit
|
* link:https://github.com/uwolfer/gerrit-intellij-plugin[Gerrit
|
||||||
IntelliJ Plugin]: Gerrit integration with the
|
IntelliJ Plugin,role=external,window=_blank]: Gerrit integration with the
|
||||||
link:http://www.jetbrains.com/idea/[IntelliJ Platform]
|
link:http://www.jetbrains.com/idea/[IntelliJ Platform,role=external,window=_blank]
|
||||||
* link:https://play.google.com/store/apps/details?id=com.jbirdvegas.mgerrit[
|
* link:https://play.google.com/store/apps/details?id=com.jbirdvegas.mgerrit[
|
||||||
mGerrit]: Android client for Gerrit
|
mGerrit,role=external,window=_blank]: Android client for Gerrit
|
||||||
* link:https://github.com/stackforge/gertty[Gertty]: Console-based
|
* link:https://github.com/stackforge/gertty[Gertty,role=external,window=_blank]: Console-based
|
||||||
interface for Gerrit
|
interface for Gerrit
|
||||||
|
|
||||||
[[clone]]
|
[[clone]]
|
||||||
@ -209,7 +209,7 @@ documentation].
|
|||||||
Instead of manually installing the `commit-msg` hook for each git
|
Instead of manually installing the `commit-msg` hook for each git
|
||||||
repository, you can copy it into the
|
repository, you can copy it into the
|
||||||
link:http://git-scm.com/docs/git-init#_template_directory[git template
|
link:http://git-scm.com/docs/git-init#_template_directory[git template
|
||||||
directory]. Then it is automatically copied to every newly cloned
|
directory,role=external,window=_blank]. Then it is automatically copied to every newly cloned
|
||||||
repository.
|
repository.
|
||||||
|
|
||||||
[[review-change]]
|
[[review-change]]
|
||||||
|
@ -29,7 +29,7 @@ From the Linux machine on which you want to install Gerrit:
|
|||||||
. Download the desired Gerrit archive.
|
. Download the desired Gerrit archive.
|
||||||
|
|
||||||
To view previous archives, see
|
To view previous archives, see
|
||||||
link:https://gerrit-releases.storage.googleapis.com/index.html[Gerrit Code Review: Releases]. The steps below install Gerrit 3.0.3:
|
link:https://gerrit-releases.storage.googleapis.com/index.html[Gerrit Code Review: Releases,role=external,window=_blank]. The steps below install Gerrit 3.0.3:
|
||||||
|
|
||||||
....
|
....
|
||||||
wget https://gerrit-releases.storage.googleapis.com/gerrit-3.0.3.war
|
wget https://gerrit-releases.storage.googleapis.com/gerrit-3.0.3.war
|
||||||
|
@ -36,7 +36,7 @@ data in the same repository as code changes.
|
|||||||
the upgrade process by running `gerrit.war init`
|
the upgrade process by running `gerrit.war init`
|
||||||
- Account, group and change metadata on the servers behind `googlesource.com` is fully
|
- Account, group and change metadata on the servers behind `googlesource.com` is fully
|
||||||
migrated to NoteDb. In other words, if you use
|
migrated to NoteDb. In other words, if you use
|
||||||
link:https://gerrit-review.googlesource.com/[gerrit-review], you're already
|
link:https://gerrit-review.googlesource.com/[gerrit-review,role=external,window=_blank], you're already
|
||||||
using NoteDb.
|
using NoteDb.
|
||||||
- NoteDb is the only database format supported by Gerrit 3.0. The change data
|
- NoteDb is the only database format supported by Gerrit 3.0. The change data
|
||||||
migration tools are only included in Gerrit 2.15 and 2.16; they are not
|
migration tools are only included in Gerrit 2.15 and 2.16; they are not
|
||||||
@ -197,5 +197,5 @@ section serves primarily as a reference.
|
|||||||
|
|
||||||
In case of rollback from NoteDB to ReviewDB, all the meta refs and the
|
In case of rollback from NoteDB to ReviewDB, all the meta refs and the
|
||||||
sequence ref need to be removed.
|
sequence ref need to be removed.
|
||||||
The [remove-notedb-refs.sh](https://gerrit.googlesource.com/gerrit/+/refs/heads/master/contrib/remove-notedb-refs.sh)
|
The [remove-notedb-refs.sh,role=external,window=_blank](https://gerrit.googlesource.com/gerrit/+/refs/heads/master/contrib/remove-notedb-refs.sh)
|
||||||
script has been written to automate this process.
|
script has been written to automate this process.
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
CAUTION: Work in progress. Hard hat area. Please
|
CAUTION: Work in progress. Hard hat area. Please
|
||||||
link:https://bugs.chromium.org/p/gerrit/issues/entry?template=PolyGerrit%20plugins[send
|
link:https://bugs.chromium.org/p/gerrit/issues/entry?template=PolyGerrit%20plugins[send
|
||||||
feedback] if something's not right.
|
feedback,role=external,window=_blank] if something's not right.
|
||||||
|
|
||||||
For migrating existing GWT UI plugins, please check out the
|
For migrating existing GWT UI plugins, please check out the
|
||||||
link:pg-plugin-migration.html#migration[migration guide].
|
link:pg-plugin-migration.html#migration[migration guide].
|
||||||
@ -11,7 +11,7 @@ link:pg-plugin-migration.html#migration[migration guide].
|
|||||||
== Plugin loading and initialization
|
== Plugin loading and initialization
|
||||||
|
|
||||||
link:js-api.html#_entry_point[Entry point] for the plugin and the loading method
|
link:js-api.html#_entry_point[Entry point] for the plugin and the loading method
|
||||||
is based on link:http://w3c.github.io/webcomponents/spec/imports/[HTML Imports]
|
is based on link:http://w3c.github.io/webcomponents/spec/imports/[HTML Imports,role=external,window=_blank]
|
||||||
spec.
|
spec.
|
||||||
|
|
||||||
* The plugin provides pluginname.html, and can be a standalone file or a static
|
* The plugin provides pluginname.html, and can be a standalone file or a static
|
||||||
@ -103,7 +103,7 @@ Gerrit.install(plugin => {
|
|||||||
|
|
||||||
A plugin may provide Polymer's
|
A plugin may provide Polymer's
|
||||||
https://www.polymer-project.org/2.0/docs/devguide/style-shadow-dom#style-modules[style
|
https://www.polymer-project.org/2.0/docs/devguide/style-shadow-dom#style-modules[style
|
||||||
modules] to style individual endpoints using
|
modules,role=external,window=_blank] to style individual endpoints using
|
||||||
`plugin.registerStyleModule(endpointName, moduleName)`. A style must be defined
|
`plugin.registerStyleModule(endpointName, moduleName)`. A style must be defined
|
||||||
as a standalone `<dom-module>` defined in the same .html file.
|
as a standalone `<dom-module>` defined in the same .html file.
|
||||||
|
|
||||||
@ -152,7 +152,7 @@ The low-level DOM API methods are the base of all UI customization.
|
|||||||
|
|
||||||
Alternative for
|
Alternative for
|
||||||
link:https://www.polymer-project.org/1.0/docs/devguide/data-binding[Polymer data
|
link:https://www.polymer-project.org/1.0/docs/devguide/data-binding[Polymer data
|
||||||
binding] for plugins that don't use Polymer. Can be used to bind element
|
binding,role=external,window=_blank] for plugins that don't use Polymer. Can be used to bind element
|
||||||
attribute changes to callbacks.
|
attribute changes to callbacks.
|
||||||
|
|
||||||
See `samples/bind-parameters.html` for examples on both Polymer data bindings
|
See `samples/bind-parameters.html` for examples on both Polymer data bindings
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
CAUTION: Work in progress. Hard hat area. Please
|
CAUTION: Work in progress. Hard hat area. Please
|
||||||
link:https://bugs.chromium.org/p/gerrit/issues/entry?template=PolyGerrit%20plugins[send
|
link:https://bugs.chromium.org/p/gerrit/issues/entry?template=PolyGerrit%20plugins[send
|
||||||
feedback] if something's not right.
|
feedback,role=external,window=_blank] if something's not right.
|
||||||
|
|
||||||
[[migration]]
|
[[migration]]
|
||||||
== Incremental migration of existing GWT UI plugins
|
== Incremental migration of existing GWT UI plugins
|
||||||
|
@ -4,17 +4,17 @@
|
|||||||
|
|
||||||
Plugins may provide
|
Plugins may provide
|
||||||
link:https://www.polymer-project.org/2.0/docs/devguide/style-shadow-dom#style-modules[Polymer
|
link:https://www.polymer-project.org/2.0/docs/devguide/style-shadow-dom#style-modules[Polymer
|
||||||
style modules] for UI CSS-based customization.
|
style modules,role=external,window=_blank] for UI CSS-based customization.
|
||||||
|
|
||||||
PolyGerrit UI implements number of styling endpoints, which apply CSS mixins
|
PolyGerrit UI implements number of styling endpoints, which apply CSS mixins
|
||||||
link:https://tabatkins.github.io/specs/css-apply-rule/[using @apply] to its
|
link:https://tabatkins.github.io/specs/css-apply-rule/[using @apply,role=external,window=_blank] to its
|
||||||
direct contents.
|
direct contents.
|
||||||
|
|
||||||
NOTE: Only items (i.e. CSS properties and mixin targets) documented here are
|
NOTE: Only items (i.e. CSS properties and mixin targets) documented here are
|
||||||
guaranteed to work in the long term, since they are covered by integration
|
guaranteed to work in the long term, since they are covered by integration
|
||||||
tests. + When there is a need to add new property or endpoint, please
|
tests. + When there is a need to add new property or endpoint, please
|
||||||
link:https://bugs.chromium.org/p/gerrit/issues/entry?template=PolyGerrit%20Issue[file
|
link:https://bugs.chromium.org/p/gerrit/issues/entry?template=PolyGerrit%20Issue[file
|
||||||
a bug] stating your use case to track and maintain for future releases.
|
a bug,role=external,window=_blank] stating your use case to track and maintain for future releases.
|
||||||
|
|
||||||
Plugins should be html-based and imported following PolyGerrit's
|
Plugins should be html-based and imported following PolyGerrit's
|
||||||
link:pg-plugin-dev.html#loading[dev guide].
|
link:pg-plugin-dev.html#loading[dev guide].
|
||||||
@ -64,7 +64,7 @@ is applied to `gr-change-metadata section.topic`
|
|||||||
|
|
||||||
Following CSS properties have
|
Following CSS properties have
|
||||||
link:https://gerrit.googlesource.com/gerrit/+/master/polygerrit-ui/app/elements/change/gr-change-metadata/gr-change-metadata-it_test.html[long-term
|
link:https://gerrit.googlesource.com/gerrit/+/master/polygerrit-ui/app/elements/change/gr-change-metadata/gr-change-metadata-it_test.html[long-term
|
||||||
support via integration test]:
|
support via integration test,role=external,window=_blank]:
|
||||||
|
|
||||||
* `display`
|
* `display`
|
||||||
+
|
+
|
||||||
|
@ -30,7 +30,7 @@ To migrate AccountPatchReviewDb:
|
|||||||
[NOTE]
|
[NOTE]
|
||||||
When using MySQL, the file_name column length in the account_patch_reviews table will be shortened
|
When using MySQL, the file_name column length in the account_patch_reviews table will be shortened
|
||||||
from the standard 4096 characters down to 255 characters. This is due to a
|
from the standard 4096 characters down to 255 characters. This is due to a
|
||||||
link:https://dev.mysql.com/doc/refman/5.7/en/innodb-restrictions.html[MySQL limitation]
|
link:https://dev.mysql.com/doc/refman/5.7/en/innodb-restrictions.html[MySQL limitation,role=external,window=_blank]
|
||||||
on the max size of 767 bytes for each column in an index.
|
on the max size of 767 bytes for each column in an index.
|
||||||
|
|
||||||
== OPTIONS
|
== OPTIONS
|
||||||
|
@ -23,10 +23,10 @@ Loading and executing Prolog submit rules may be disabled by setting
|
|||||||
link:config-gerrit.html#_a_id_rules_a_section_rules[rules section])
|
link:config-gerrit.html#_a_id_rules_a_section_rules[rules section])
|
||||||
|
|
||||||
link:https://groups.google.com/d/topic/repo-discuss/wJxTGhlHZMM/discussion[This
|
link:https://groups.google.com/d/topic/repo-discuss/wJxTGhlHZMM/discussion[This
|
||||||
discussion thread] explains why Prolog was chosen for the purpose of writing
|
discussion thread,role=external,window=_blank] explains why Prolog was chosen for the purpose of writing
|
||||||
project specific submit rules.
|
project specific submit rules.
|
||||||
link:http://gerrit-documentation.googlecode.com/svn/ReleaseNotes/ReleaseNotes-2.2.2.html[Gerrit
|
link:http://gerrit-documentation.googlecode.com/svn/ReleaseNotes/ReleaseNotes-2.2.2.html[Gerrit
|
||||||
2.2.2 ReleaseNotes] introduces Prolog support in Gerrit.
|
2.2.2 ReleaseNotes,role=external,window=_blank] introduces Prolog support in Gerrit.
|
||||||
|
|
||||||
[[SubmitType]]
|
[[SubmitType]]
|
||||||
== Submit Type
|
== Submit Type
|
||||||
@ -58,14 +58,14 @@ situation.
|
|||||||
|
|
||||||
== Prolog Language
|
== Prolog Language
|
||||||
This document is not a complete Prolog tutorial.
|
This document is not a complete Prolog tutorial.
|
||||||
link:http://en.wikipedia.org/wiki/Prolog[This Wikipedia page on Prolog] is a
|
link:http://en.wikipedia.org/wiki/Prolog[This Wikipedia page on Prolog,role=external,window=_blank] is a
|
||||||
good starting point for learning the Prolog language. This document will only
|
good starting point for learning the Prolog language. This document will only
|
||||||
explain some elements of Prolog that are necessary to understand the provided
|
explain some elements of Prolog that are necessary to understand the provided
|
||||||
examples.
|
examples.
|
||||||
|
|
||||||
== Prolog in Gerrit
|
== Prolog in Gerrit
|
||||||
Gerrit uses its own link:https://gerrit.googlesource.com/prolog-cafe/[fork] of the
|
Gerrit uses its own link:https://gerrit.googlesource.com/prolog-cafe/[fork,role=external,window=_blank] of the
|
||||||
original link:http://kaminari.istc.kobe-u.ac.jp/PrologCafe/[prolog-cafe]
|
original link:http://kaminari.istc.kobe-u.ac.jp/PrologCafe/[prolog-cafe,role=external,window=_blank]
|
||||||
project. Gerrit embeds the prolog-cafe library and can interpret Prolog programs
|
project. Gerrit embeds the prolog-cafe library and can interpret Prolog programs
|
||||||
at runtime.
|
at runtime.
|
||||||
|
|
||||||
@ -75,7 +75,7 @@ link:pgm-prolog-shell.html[prolog-shell] program which opens an interactive
|
|||||||
Prolog interpreter shell.
|
Prolog interpreter shell.
|
||||||
|
|
||||||
For batch or unit tests, see the examples in Gerrit source directory
|
For batch or unit tests, see the examples in Gerrit source directory
|
||||||
link:https://gerrit.googlesource.com/gerrit/+/refs/heads/master/prologtests/examples/[prologtests/examples].
|
link:https://gerrit.googlesource.com/gerrit/+/refs/heads/master/prologtests/examples/[prologtests/examples,role=external,window=_blank].
|
||||||
|
|
||||||
[NOTE]
|
[NOTE]
|
||||||
The interactive shell is just a prolog shell, it does not load
|
The interactive shell is just a prolog shell, it does not load
|
||||||
@ -84,7 +84,7 @@ xref:TestingSubmitRules[testing submit rules].
|
|||||||
|
|
||||||
== SWI-Prolog
|
== SWI-Prolog
|
||||||
Instead of using the link:pgm-prolog-shell.html[prolog-shell] program one can
|
Instead of using the link:pgm-prolog-shell.html[prolog-shell] program one can
|
||||||
also use the link:http://www.swi-prolog.org/[SWI-Prolog] environment. It
|
also use the link:http://www.swi-prolog.org/[SWI-Prolog,role=external,window=_blank] environment. It
|
||||||
provides a better shell interface and a graphical source-level debugger.
|
provides a better shell interface and a graphical source-level debugger.
|
||||||
|
|
||||||
[[RulesFile]]
|
[[RulesFile]]
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
Gerrit does not provide out of the box quota enforcement. However, it does
|
Gerrit does not provide out of the box quota enforcement. However, it does
|
||||||
support an extension mechanism for plugins to hook into to provide this
|
support an extension mechanism for plugins to hook into to provide this
|
||||||
functionality. The most prominent plugin is the
|
functionality. The most prominent plugin is the
|
||||||
link:https://gerrit.googlesource.com/plugins/quota/[Quota Plugin].
|
link:https://gerrit.googlesource.com/plugins/quota/[Quota Plugin,role=external,window=_blank].
|
||||||
|
|
||||||
This documentation is intended to be read by plugin developers. It contains all
|
This documentation is intended to be read by plugin developers. It contains all
|
||||||
quota requests implemented in Gerrit-core as well as the metadata that they have
|
quota requests implemented in Gerrit-core as well as the metadata that they have
|
||||||
|
@ -2661,7 +2661,7 @@ The `GpgKeyInfo` entity contains information about a GPG public key.
|
|||||||
|`id` |Not set in map context|The 8-char hex GPG key ID.
|
|`id` |Not set in map context|The 8-char hex GPG key ID.
|
||||||
|`fingerprint`|Not set for deleted keys|The 40-char (plus spaces) hex GPG key fingerprint.
|
|`fingerprint`|Not set for deleted keys|The 40-char (plus spaces) hex GPG key fingerprint.
|
||||||
|`user_ids` |Not set for deleted keys|
|
|`user_ids` |Not set for deleted keys|
|
||||||
link:https://tools.ietf.org/html/rfc4880#section-5.11[OpenPGP User IDs]
|
link:https://tools.ietf.org/html/rfc4880#section-5.11[OpenPGP User IDs,role=external,window=_blank]
|
||||||
associated with the public key.
|
associated with the public key.
|
||||||
|`key` |Not set for deleted keys|ASCII armored public key material.
|
|`key` |Not set for deleted keys|ASCII armored public key material.
|
||||||
|`status` |Not set for deleted keys|
|
|`status` |Not set for deleted keys|
|
||||||
|
@ -2356,7 +2356,7 @@ If the change was already not private, the response is "`409 Conflict`".
|
|||||||
A message can be specified in the request body inside a
|
A message can be specified in the request body inside a
|
||||||
link:#private-input[PrivateInput] entity. Historically, this method allowed
|
link:#private-input[PrivateInput] entity. Historically, this method allowed
|
||||||
a body in the DELETE, but that behavior is
|
a body in the DELETE, but that behavior is
|
||||||
link:https://www.gerritcodereview.com/releases/2.16.md[deprecated].
|
link:https://www.gerritcodereview.com/releases/2.16.md[deprecated,role=external,window=_blank].
|
||||||
In this case, use a POST request instead:
|
In this case, use a POST request instead:
|
||||||
|
|
||||||
.Request
|
.Request
|
||||||
@ -3342,7 +3342,7 @@ Deletes a reviewer from a change.
|
|||||||
Options can be provided in the request body as a
|
Options can be provided in the request body as a
|
||||||
link:#delete-reviewer-input[DeleteReviewerInput] entity.
|
link:#delete-reviewer-input[DeleteReviewerInput] entity.
|
||||||
Historically, this method allowed a body in the DELETE, but that behavior is
|
Historically, this method allowed a body in the DELETE, but that behavior is
|
||||||
link:https://www.gerritcodereview.com/releases/2.16.md[deprecated].
|
link:https://www.gerritcodereview.com/releases/2.16.md[deprecated,role=external,window=_blank].
|
||||||
In this case, use a POST request instead:
|
In this case, use a POST request instead:
|
||||||
|
|
||||||
.Request
|
.Request
|
||||||
@ -3422,7 +3422,7 @@ a reviewer is removed the reviewer itself is still listed on the change.
|
|||||||
Options can be provided in the request body as a
|
Options can be provided in the request body as a
|
||||||
link:#delete-vote-input[DeleteVoteInput] entity.
|
link:#delete-vote-input[DeleteVoteInput] entity.
|
||||||
Historically, this method allowed a body in the DELETE, but that behavior is
|
Historically, this method allowed a body in the DELETE, but that behavior is
|
||||||
link:https://www.gerritcodereview.com/releases/2.16.md[deprecated].
|
link:https://www.gerritcodereview.com/releases/2.16.md[deprecated,role=external,window=_blank].
|
||||||
In this case, use a POST request instead:
|
In this case, use a POST request instead:
|
||||||
|
|
||||||
.Request
|
.Request
|
||||||
@ -4795,7 +4795,7 @@ global capability are permitted to delete a comment.
|
|||||||
Deletion reason can be provided in the request body as a
|
Deletion reason can be provided in the request body as a
|
||||||
link:#delete-comment-input[DeleteCommentInput] entity.
|
link:#delete-comment-input[DeleteCommentInput] entity.
|
||||||
Historically, this method allowed a body in the DELETE, but that behavior is
|
Historically, this method allowed a body in the DELETE, but that behavior is
|
||||||
link:https://www.gerritcodereview.com/releases/2.16.md[deprecated].
|
link:https://www.gerritcodereview.com/releases/2.16.md[deprecated,role=external,window=_blank].
|
||||||
In this case, use a POST request instead:
|
In this case, use a POST request instead:
|
||||||
|
|
||||||
.Request
|
.Request
|
||||||
@ -5615,7 +5615,7 @@ is still listed on the change.
|
|||||||
Options can be provided in the request body as a
|
Options can be provided in the request body as a
|
||||||
link:#delete-vote-input[DeleteVoteInput] entity.
|
link:#delete-vote-input[DeleteVoteInput] entity.
|
||||||
Historically, this method allowed a body in the DELETE, but that behavior is
|
Historically, this method allowed a body in the DELETE, but that behavior is
|
||||||
link:https://www.gerritcodereview.com/releases/2.16.md[deprecated].
|
link:https://www.gerritcodereview.com/releases/2.16.md[deprecated,role=external,window=_blank].
|
||||||
In this case, use a POST request instead:
|
In this case, use a POST request instead:
|
||||||
|
|
||||||
.Request
|
.Request
|
||||||
|
@ -610,7 +610,7 @@ Deletes the description of a project.
|
|||||||
A commit message can be provided in the request body as a
|
A commit message can be provided in the request body as a
|
||||||
link:#project-description-input[ProjectDescriptionInput] entity.
|
link:#project-description-input[ProjectDescriptionInput] entity.
|
||||||
Historically, this method allowed a body in the DELETE, but that behavior is
|
Historically, this method allowed a body in the DELETE, but that behavior is
|
||||||
link:https://www.gerritcodereview.com/releases/2.16.md[deprecated].
|
link:https://www.gerritcodereview.com/releases/2.16.md[deprecated,role=external,window=_blank].
|
||||||
In this case, use link:#set-project-description[PUT] instead.
|
In this case, use link:#set-project-description[PUT] instead.
|
||||||
|
|
||||||
.Request
|
.Request
|
||||||
|
@ -128,7 +128,7 @@ must be URL encoded.
|
|||||||
=== Response Codes
|
=== Response Codes
|
||||||
The Gerrit REST endpoints use HTTP status codes as described
|
The Gerrit REST endpoints use HTTP status codes as described
|
||||||
in the link:http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html[
|
in the link:http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html[
|
||||||
HTTP specification].
|
HTTP specification,role=external,window=_blank].
|
||||||
|
|
||||||
In most cases, the response body of an error response will be a
|
In most cases, the response body of an error response will be a
|
||||||
plaintext, human-readable error message.
|
plaintext, human-readable error message.
|
||||||
|
@ -16,7 +16,7 @@ To learn more, see the link:intro-user.html[Gerrit User's Guide].
|
|||||||
|
|
||||||
To create a change in the Gerrit web interface:
|
To create a change in the Gerrit web interface:
|
||||||
|
|
||||||
. From the link:http://gerrit-review.googlesource.com[Gerrit Code Review]
|
. From the link:http://gerrit-review.googlesource.com[Gerrit Code Review,role=external,window=_blank]
|
||||||
dashboard, select Browse > Repositories.
|
dashboard, select Browse > Repositories.
|
||||||
|
|
||||||
. Under Repository Name, click the name of the repository you want to work
|
. Under Repository Name, click the name of the repository you want to work
|
||||||
|
@ -75,7 +75,7 @@ triggered the auto-retry, however this is not guaranteed:
|
|||||||
[[auto-retry-succeeded]]
|
[[auto-retry-succeeded]]
|
||||||
If an auto-retry succeeds you may consider filing this as
|
If an auto-retry succeeds you may consider filing this as
|
||||||
link:https://bugs.chromium.org/p/gerrit/issues/entry?template=GoogleSource+Issue[
|
link:https://bugs.chromium.org/p/gerrit/issues/entry?template=GoogleSource+Issue[
|
||||||
Gerrit issue] so that the Gerrit developers can fix this and treat this
|
Gerrit issue,role=external,window=_blank] so that the Gerrit developers can fix this and treat this
|
||||||
exception as recoverable.
|
exception as recoverable.
|
||||||
|
|
||||||
The trace IDs for auto-retries are generated and start with
|
The trace IDs for auto-retries are generated and start with
|
||||||
|
@ -432,7 +432,7 @@ image::images/user-review-ui-change-screen-download-commands.png[width=800, link
|
|||||||
The available download commands depend on the installed Gerrit plugins.
|
The available download commands depend on the installed Gerrit plugins.
|
||||||
The most popular plugin for download commands, the
|
The most popular plugin for download commands, the
|
||||||
link:https://gerrit-review.googlesource.com/admin/repos/plugins/download-commands[
|
link:https://gerrit-review.googlesource.com/admin/repos/plugins/download-commands[
|
||||||
download-commands] plugin, provides commands to checkout, pull and
|
download-commands,role=external,window=_blank] plugin, provides commands to checkout, pull and
|
||||||
cherry-pick a patch set.
|
cherry-pick a patch set.
|
||||||
|
|
||||||
Each command has a copy-to-clipboard icon that allows the command to be
|
Each command has a copy-to-clipboard icon that allows the command to be
|
||||||
@ -943,7 +943,7 @@ previous match. Skipped lines are automatically expanded if they
|
|||||||
contain a match and one navigates to it.
|
contain a match and one navigates to it.
|
||||||
|
|
||||||
For additional possibilities to search please check the
|
For additional possibilities to search please check the
|
||||||
link:http://www.vim.org/docs.php[Vim documentation]. There are other
|
link:http://www.vim.org/docs.php[Vim documentation,role=external,window=_blank]. There are other
|
||||||
useful ways to search, e.g. while the cursor is on a word, pressing `*`
|
useful ways to search, e.g. while the cursor is on a word, pressing `*`
|
||||||
or `#` searches for the next or previous occurrence of the word.
|
or `#` searches for the next or previous occurrence of the word.
|
||||||
|
|
||||||
@ -962,7 +962,7 @@ Vim-like commands can be used to navigate within a patch file:
|
|||||||
- `gg` / `G` moves to cursor to the start / end of the file
|
- `gg` / `G` moves to cursor to the start / end of the file
|
||||||
- `Ctrl-D` / `Ctrl-U` scrolls downwards / upwards
|
- `Ctrl-D` / `Ctrl-U` scrolls downwards / upwards
|
||||||
|
|
||||||
Please check the link:http://www.vim.org/docs.php[Vim documentation]
|
Please check the link:http://www.vim.org/docs.php[Vim documentation,role=external,window=_blank]
|
||||||
for further information.
|
for further information.
|
||||||
|
|
||||||
[[diff-preferences]]
|
[[diff-preferences]]
|
||||||
|
@ -161,7 +161,7 @@ project:'PROJECT', p:'PROJECT'::
|
|||||||
Changes occurring in 'PROJECT'. If 'PROJECT' starts with `^` it
|
Changes occurring in 'PROJECT'. If 'PROJECT' starts with `^` it
|
||||||
matches project names by regular expression. The
|
matches project names by regular expression. The
|
||||||
link:http://www.brics.dk/automaton/[dk.brics.automaton
|
link:http://www.brics.dk/automaton/[dk.brics.automaton
|
||||||
library] is used for evaluation of such patterns.
|
library,role=external,window=_blank] is used for evaluation of such patterns.
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
projects:'PREFIX'::
|
projects:'PREFIX'::
|
||||||
@ -180,7 +180,7 @@ repository:'REPOSITORY', repo:'REPOSITORY'::
|
|||||||
Changes occurring in 'REPOSITORY'. If 'REPOSITORY' starts with `^` it
|
Changes occurring in 'REPOSITORY'. If 'REPOSITORY' starts with `^` it
|
||||||
matches repository names by regular expression. The
|
matches repository names by regular expression. The
|
||||||
link:http://www.brics.dk/automaton/[dk.brics.automaton
|
link:http://www.brics.dk/automaton/[dk.brics.automaton
|
||||||
library] is used for evaluation of such patterns.
|
library,role=external,window=_blank] is used for evaluation of such patterns.
|
||||||
|
|
||||||
[[repositories]]
|
[[repositories]]
|
||||||
repositories:'PREFIX', repos:'PREFIX'::
|
repositories:'PREFIX', repos:'PREFIX'::
|
||||||
@ -203,7 +203,7 @@ the traditional 'refs/heads/' prefix.
|
|||||||
If 'BRANCH' starts with `^` it matches branch names by regular
|
If 'BRANCH' starts with `^` it matches branch names by regular
|
||||||
expression patterns. The
|
expression patterns. The
|
||||||
link:http://www.brics.dk/automaton/[dk.brics.automaton
|
link:http://www.brics.dk/automaton/[dk.brics.automaton
|
||||||
library] is used for evaluation of such patterns.
|
library,role=external,window=_blank] is used for evaluation of such patterns.
|
||||||
|
|
||||||
[[intopic]]
|
[[intopic]]
|
||||||
intopic:'TOPIC'::
|
intopic:'TOPIC'::
|
||||||
@ -213,7 +213,7 @@ Changes whose designated topic contains 'TOPIC', using a full-text search.
|
|||||||
If 'TOPIC' starts with `^` it matches topic names by regular
|
If 'TOPIC' starts with `^` it matches topic names by regular
|
||||||
expression patterns. The
|
expression patterns. The
|
||||||
link:http://www.brics.dk/automaton/[dk.brics.automaton
|
link:http://www.brics.dk/automaton/[dk.brics.automaton
|
||||||
library] is used for evaluation of such patterns.
|
library,role=external,window=_blank] is used for evaluation of such patterns.
|
||||||
|
|
||||||
[[topic]]
|
[[topic]]
|
||||||
topic:'TOPIC'::
|
topic:'TOPIC'::
|
||||||
@ -238,7 +238,7 @@ must start with 'refs/'.
|
|||||||
If 'REF' starts with `^` it matches reference names by regular
|
If 'REF' starts with `^` it matches reference names by regular
|
||||||
expression patterns. The
|
expression patterns. The
|
||||||
link:http://www.brics.dk/automaton/[dk.brics.automaton
|
link:http://www.brics.dk/automaton/[dk.brics.automaton
|
||||||
library] is used for evaluation of such patterns.
|
library,role=external,window=_blank] is used for evaluation of such patterns.
|
||||||
|
|
||||||
[[tr,bug]]
|
[[tr,bug]]
|
||||||
tr:'ID', bug:'ID'::
|
tr:'ID', bug:'ID'::
|
||||||
@ -273,7 +273,7 @@ path:'PATH'::
|
|||||||
Matches any change touching file at 'PATH'. By default exact path
|
Matches any change touching file at 'PATH'. By default exact path
|
||||||
matching is used, but regular expressions can be enabled by starting
|
matching is used, but regular expressions can be enabled by starting
|
||||||
with `^`. For example, to match all XML files use `file:^.*\.xml$`.
|
with `^`. For example, to match all XML files use `file:^.*\.xml$`.
|
||||||
The link:http://www.brics.dk/automaton/[dk.brics.automaton library]
|
The link:http://www.brics.dk/automaton/[dk.brics.automaton library,role=external,window=_blank]
|
||||||
is used for the evaluation of such patterns.
|
is used for the evaluation of such patterns.
|
||||||
+
|
+
|
||||||
The `^` required at the beginning of the regular expression not only
|
The `^` required at the beginning of the regular expression not only
|
||||||
@ -332,7 +332,7 @@ but are not mandatory.
|
|||||||
+
|
+
|
||||||
If 'DIR' starts with `^` it matches directories and directory segments by
|
If 'DIR' starts with `^` it matches directories and directory segments by
|
||||||
regular expression. The link:http://www.brics.dk/automaton/[dk.brics.automaton
|
regular expression. The link:http://www.brics.dk/automaton/[dk.brics.automaton
|
||||||
library] is used for evaluation of such patterns.
|
library,role=external,window=_blank] is used for evaluation of such patterns.
|
||||||
|
|
||||||
[[footer-operator]]
|
[[footer-operator]]
|
||||||
footer:'FOOTER'::
|
footer:'FOOTER'::
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
= Gerrit Code Review - Signed-off-by Lines
|
= Gerrit Code Review - Signed-off-by Lines
|
||||||
|
|
||||||
[NOTE]
|
[NOTE]
|
||||||
This document was literally taken from link:http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob;f=Documentation/SubmittingPatches;hb=4e8a2372f9255a1464ef488ed925455f53fbdaa1[linux-2.6 Documentation/SubmittingPatches]
|
This document was literally taken from link:http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob;f=Documentation/SubmittingPatches;hb=4e8a2372f9255a1464ef488ed925455f53fbdaa1[linux-2.6 Documentation/SubmittingPatches,role=external,window=_blank]
|
||||||
and is covered by the GPLv2.
|
and is covered by the GPLv2.
|
||||||
|
|
||||||
[[Signed-off-by]]
|
[[Signed-off-by]]
|
||||||
|
@ -618,7 +618,7 @@ To create multiple new changes, run push multiple times.
|
|||||||
|
|
||||||
repo is a multiple repository management tool, most commonly
|
repo is a multiple repository management tool, most commonly
|
||||||
used by the Android Open Source Project. For more details, see
|
used by the Android Open Source Project. For more details, see
|
||||||
link:http://source.android.com/source/using-repo.html[using repo].
|
link:http://source.android.com/source/using-repo.html[using repo,role=external,window=_blank].
|
||||||
|
|
||||||
[[repo_create]]
|
[[repo_create]]
|
||||||
=== Create Changes
|
=== Create Changes
|
||||||
|
Loading…
x
Reference in New Issue
Block a user