gerrit/Documentation/cmd-plugin-reload.txt
David Myllykangas 511823f835 Documentation update for cmd-plugin
Update the Access section on documentation of the cmd-plugin
command to also include config to enable the command.

Change-Id: I815275009494db6ce3027a2705b0056146ba7a0f
2015-01-21 11:03:08 +09:00

47 lines
1005 B
Plaintext

= plugin reload
== NAME
plugin reload - Reload/Restart plugins.
== SYNOPSIS
--
'ssh' -p <port> <host> 'gerrit plugin reload'
<NAME> ...
--
== DESCRIPTION
Reload/Restart plugins.
Whether a plugin is reloaded or restarted is defined by the plugin's
link:dev-plugins.html#reload_method[reload method].
E.g. a plugin needs to be reloaded if its configuration is modified to
make the new configuration data become active.
== ACCESS
* Caller must be a member of the privileged 'Administrators' group.
* link:config-gerrit.html#plugins.allowRemoteAdmin[plugins.allowRemoteAdmin]
must be enabled in `$site_path/etc/gerrit.config`.
== SCRIPTING
This command is intended to be used in scripts.
== OPTIONS
<NAME>::
Name of the plugin that should be reloaded. Multiple names of
plugins that should be reloaded may be specified.
== EXAMPLES
Reload a plugin:
====
ssh -p 29418 localhost gerrit plugin reload my-plugin
====
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------