summaryrefslogtreecommitdiffstats
path: root/Documentation/cmd-flush-caches.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/cmd-flush-caches.txt')
-rw-r--r--Documentation/cmd-flush-caches.txt19
1 files changed, 11 insertions, 8 deletions
diff --git a/Documentation/cmd-flush-caches.txt b/Documentation/cmd-flush-caches.txt
index 573cd78936..bc6fac54ef 100644
--- a/Documentation/cmd-flush-caches.txt
+++ b/Documentation/cmd-flush-caches.txt
@@ -8,8 +8,9 @@ gerrit flush-caches - Flush some/all server caches from memory
SYNOPSIS
--------
[verse]
- 'ssh' -p <port> <host> 'gerrit flush-caches' \
- [\--all | \--list | \--cache <NAME> ...]
+'ssh' -p <port> <host> 'gerrit flush-caches' --all
+'ssh' -p <port> <host> 'gerrit flush-caches' --list
+'ssh' -p <port> <host> 'gerrit flush-caches' --cache <NAME> ...
DESCRIPTION
-----------
@@ -24,7 +25,9 @@ If no options are supplied, defaults to `--all`.
ACCESS
------
-Caller must be a member of the privileged 'Administrators' group.
+Caller must be a member of the privileged 'Administrators' group,
+or in a group that have been granted
+link:access-control.html#capability_flushCaches[the 'Flush Caches' global capability].
SCRIPTING
---------
@@ -32,19 +35,19 @@ This command is intended to be used in scripts.
OPTIONS
-------
-\--all::
+--all::
Flush all known caches. This is like applying a big hammer,
it will force everything out, potentially more than was
- necessary for the change made. This option automatically
+ necessary for the change made. This option automatically
skips flushing potentially dangerous caches such as
"web_sessions". To flush one of these caches, the caller
must specifically name them on the command line, e.g. pass
- `\--cache=web_sessions`.
+ `--cache web_sessions`.
-\--list::
+--list::
Show a list of the caches.
-\--cache=<NAME>::
+--cache <NAME>::
Flush only the cache called <NAME>. May be supplied more
than once to flush multiple caches in a single command
execution.