openstack/swift
Code Issues Proposed changes

Update swift-recon doc with more options

Browse Source 
The swit-recon tool has had several functional additions
added recently but not all of these have been added to the docs.

This change adds the following options to the manpages:

  --human-readable
  --validate-servers
  --sockstat
  --driveaudit
  --region
  --timeout

Also fixes a typo on line 78 (cop -> copy)

Change-Id: Id083b32a60473ad5a2b9ac1d092528d230521c86
This commit is contained in:
Lorcan 2015-04-15 11:32:32 +01:00
parent 5ef2e9ec00
commit 193fe9a5f9
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/manpages/swift-recon.1
View File

@ -66,16 +66,28 @@ Get disk usage stats
Also show the top COUNT entries in rank order Also show the top COUNT entries in rank order
.IP "\fB--lowest=COUNT\fR" .IP "\fB--lowest=COUNT\fR"
Also show the lowest COUNT entries in rank order Also show the lowest COUNT entries in rank order
.IP "\fB--human-readable\fR"
Use human readable suffix for disk usage stats
.IP "\fB-l, --loadstats\fR" .IP "\fB-l, --loadstats\fR"
Get cluster load average stats Get cluster load average stats
.IP "\fB-q, --quarantined\fR" .IP "\fB-q, --quarantined\fR"
Get cluster quarantine stats Get cluster quarantine stats
.IP "\fB--validate-servers\fR"
Validate servers on the ring
.IP "\fB--md5\fR" .IP "\fB--md5\fR"
Get md5sum of servers ring and compare to local cop Get md5sum of servers ring and compare to local copy
.IP "\fB--sockstat\fR"
Get cluster socket usage stats
.IP "\fB--driveaudit\fR"
Get drive audit error stats
.IP "\fB--all\fR" .IP "\fB--all\fR"
Perform all checks. Equivalent to \-arudlq \-\-md5 Perform all checks. Equivalent to \-arudlq \-\-md5
.IP "\fB--region=REGION\fR"
Only query servers in specified region
.IP "\fB-z ZONE, --zone=ZONE\fR" .IP "\fB-z ZONE, --zone=ZONE\fR"
Only query servers in specified zone Only query servers in specified zone
.IP "\fB-t SECONDS, --timeout=SECONDS\fR"
Time to wait for a response from a server
.IP "\fB--swiftdir=PATH\fR" .IP "\fB--swiftdir=PATH\fR"
Default = /etc/swift Default = /etc/swift
.PD .PD