opendev/gerrit
Code Issues Proposed changes
Files
d823dfac818d7b235d86ccd83c9539fe65d1c01b
gerrit/Documentation/cmd-index.txt
Gustaf Lundh e0f52ff170 Support reloading of gerrit.config 
This change introduces a mechanism to allow reloading of the
@GerritServerConfig. To execute a reload of gerrit.config, the SSH
command "reload-config" is provided.

Challenges and implementation:
------------------------------
Most callers that inject @GerritServerConfig are @Singletons. These
@Singletons will only parse the GerritServerConfig once and then
build and store more suitable datastructures to work from.

To allow these modules to react on config changes, a caller can now
implement GerritConfigListener, which will enable the caller to receive
notifications of future config updates.

The GerritConfigListener provides:

    void configUpdated(ConfigUpdatedEvent event);

The ConfigUpdatedEvent provides the old config and the new one.
Implementing classes of the listener are expected to do three things:

1. Investigate if any of the updated config values are of interest.
The ConfigUpdatedEvent provides helper methods for this purpose:

    public boolean isSectionUpdated(String section)
    public boolean isValueUpdated(String section, String subsection, String name)
    (+ various overloaded versions of these)

2. React to the configuration changes (if any) and apply them

3. Accept or reject the entries of interest:

    public void accept(Set<ConfigKey> entries)
    public void accept(String section)
    public void reject(Set<ConfigKey> entries)
    (+ various overloaded versions of these)

When a section (or specific config keys) are accepted or rejected, the
ConfigUpdatedEvent will build a diff of what changes were accepted and
present it to the administrator that issued a configuration reload.

For instance, in this case, 4 config rows where added(+), 2 removed(-1)
and 1 modified. All but one change were accepted, hence the user would get
this output:

$ ssh $HOST -p 29418 gerrit reload-config

Accepted configuration changes:
- suggest.maxSuggestedReviewers = 10
- suggest.accounts = 50
* addreviewer.maxAllowed = [100 => 1000]
+ sshd.requestLog = true
+ commentlink.changeid.link = #/q/$1
+ commentlink.changeid.match = (I[0-9a-f]{8,40})

Rejected configuration changes:
+ gc.startTime = Fri 10:30

Documentation:
--------------
We start by documenting the config entries that support config reloads
(which number will be increasing over time).

When we support reloading of the majority of config settings, the
documentation can switch to documenting the config entries that does
_not_ support config reloading instead.

Roadmap:
--------
This change will be followed by a couple of changes that introduces
reloadable config support for: suggest-reviewers, sshd-log and
commentlinks.

Other stuff TODO includes:
* REST end point
* Rejection messages (to allow for an explanation on why the value was
not accepted)
* Test cases
* An option to allow displaying the current effective configuration
* A lot of implementations of the GerritConfigListener.

Change-Id: I4bd6f389731af303ef9ba5d1d73f173d869c62e4
2018-04-19 13:21:24 +02:00

214 lines
6.0 KiB
Plaintext
Raw Blame History

= Gerrit Code Review - Command Line Tools
== Client
Client commands and hooks can be downloaded via scp, wget or curl
from Gerrit's daemon, and then executed on the client system.
To download a client command or hook, use scp or an http client:
----
$ scp -p -P 29418 john.doe@review.example.com:bin/gerrit-cherry-pick ~/bin/
$ scp -p -P 29418 john.doe@review.example.com:hooks/commit-msg .git/hooks/
$ curl -Lo ~/bin/gerrit-cherry-pick http://review.example.com/tools/bin/gerrit-cherry-pick
$ curl -Lo .git/hooks/commit-msg http://review.example.com/tools/hooks/commit-msg
----
For more details on how to determine the correct SSH port number,
see link:user-upload.html#test_ssh[Testing Your SSH Connection].
=== [[client_commands]]Commands
link:cmd-cherry-pick.html[gerrit-cherry-pick]::
Download and cherry-pick one or more changes (commits).
=== [[client_hooks]]Hooks
Client hooks can be installed into a local Git repository, improving
the developer experience when working with a Gerrit Code Review
server.
link:cmd-hook-commit-msg.html[commit-msg]::
Automatically generate `Change-Id: ` tags in commit messages.
== Server
Aside from the standard Git server side actions, Gerrit supports
several other commands over its internal SSH daemon. As Gerrit does
not provide an interactive shell, the commands must be triggered
from an ssh client, for example:
----
$ ssh -p 29418 review.example.com gerrit ls-projects
----
For more details on how to determine the correct SSH port number,
see link:user-upload.html#test_ssh[Testing Your SSH Connection].
=== [[user_commands]]User Commands
link:cmd-apropos.html[gerrit apropos]::
Search Gerrit documentation index.
link:cmd-ban-commit.html[gerrit ban-commit]::
Bans a commit from a project's repository.
link:cmd-create-branch.html[gerrit create-branch]::
Create a new project branch.
link:cmd-ls-groups.html[gerrit ls-groups]::
List groups visible to the caller.
link:cmd-ls-members.html[gerrit ls-members]::
List the membership of a group visible to the caller.
link:cmd-ls-projects.html[gerrit ls-projects]::
List projects visible to the caller.
link:cmd-query.html[gerrit query]::
Query the change database.
'gerrit receive-pack'::
'Deprecated alias for `git receive-pack`.'
link:cmd-rename-group.html[gerrit rename-group]::
Rename an account group.
link:cmd-review.html[gerrit review]::
Verify, approve and/or submit a patch set from the command line.
link:cmd-set-head.html[gerrit set-head]::
Change the HEAD reference of a project.
link:cmd-set-project.html[gerrit set-project]::
Change a project's settings.
link:cmd-set-reviewers.html[gerrit set-reviewers]::
Add or remove reviewers on a change.
link:cmd-stream-events.html[gerrit stream-events]::
Monitor events occurring in real time.
link:cmd-version.html[gerrit version]::
Show the currently executing version of Gerrit.
link:cmd-receive-pack.html[git receive-pack]::
Standard Git server side command for client side `git push`.
+
Also implements the magic associated with uploading commits for
review. See link:user-upload.html#push_create[Creating Changes].
git upload-pack::
Standard Git server side command for client side `git fetch`.
[[admin_commands]]Administrator Commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
link:cmd-close-connection.html[gerrit close-connection]::
Close the specified SSH connection.
link:cmd-create-account.html[gerrit create-account]::
Create a new user account.
link:cmd-create-group.html[gerrit create-group]::
Create a new account group.
link:cmd-create-project.html[gerrit create-project]::
Create a new project and associated Git repository.
link:cmd-flush-caches.html[gerrit flush-caches]::
Flush some/all server caches from memory.
link:cmd-gc.html[gerrit gc]::
Run the Git garbage collection.
link:cmd-gsql.html[gerrit gsql]::
Administrative interface to active database.
link:cmd-index-activate.html[gerrit index activate]::
Activate the latest index version available.
link:cmd-index-start.html[gerrit index start]::
Start the online indexer.
link:cmd-index-changes.html[gerrit index changes]::
Index one or more changes.
link:cmd-index-project.html[gerrit index project]::
Index all the changes in one or more projects.
link:cmd-logging-ls-level.html[gerrit logging ls-level]::
List loggers and their logging level.
link:cmd-logging-set-level.html[gerrit logging set-level]::
Set the logging level of loggers.
link:cmd-ls-user-refs.html[gerrit ls-user-refs]::
Lists refs visible for a specified user.
link:cmd-plugin-install.html[gerrit plugin add]::
Alias for 'gerrit plugin install'.
link:cmd-plugin-enable.html[gerrit plugin enable]::
Enable plugins.
link:cmd-plugin-install.html[gerrit plugin install]::
Install/Add a plugin.
link:cmd-plugin-ls.html[gerrit plugin ls]::
List the installed plugins.
link:cmd-plugin-reload.html[gerrit plugin reload]::
Reload/Restart plugins.
link:cmd-plugin-remove.html[gerrit plugin remove]::
Disable plugins.
link:cmd-plugin-remove.html[gerrit plugin rm]::
Alias for 'gerrit plugin remove'.
link:cmd-reload-config.html[gerrit reload-config]::
Apply an updated gerrit.config.
link:cmd-set-account.html[gerrit set-account]::
Change an account's settings.
link:cmd-set-members.html[gerrit set-members]::
Set group members.
link:cmd-set-project-parent.html[gerrit set-project-parent]::
Change the project permissions are inherited from.
link:cmd-show-caches.html[gerrit show-caches]::
Display current cache statistics.
link:cmd-show-connections.html[gerrit show-connections]::
Display active client SSH connections.
link:cmd-show-queue.html[gerrit show-queue]::
Display the background work queues, including replication.
link:cmd-test-submit-rule.html[gerrit test-submit rule]::
Test prolog submit rules.
link:cmd-test-submit-type.html[gerrit test-submit type]::
Test prolog submit type.
link:cmd-kill.html[kill]::
Kills a scheduled or running task.
link:cmd-show-queue.html[ps]::
Alias for 'gerrit show-queue'.
link:cmd-suexec.html[suexec]::
Execute a command as any registered user account.
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------
View Git Blame Copy Permalink