opendev/gerrit
Code Issues Proposed changes

documentation: Clean up command line documentation, examples

Browse Source 
The formatting was pretty wrong after upgrading to a newer version
of AsciiDoc, so fix up most of the formatting, correct some order
of commands in the index, and make create-project conform to the
same format used by create-account and create-group.

Change-Id: I555969655ba135e549f0b8b5b02e5f3669a0b282
This commit is contained in:
Shawn O. Pearce
2011-06-14 16:40:48 -07:00
parent 4c7f920816
commit 477692458c
19 changed files with 272 additions and 203 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
Documentation/cmd-flush-caches.txt
View File

@@ -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
-----------
@@ -32,19 +33,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.