openstack/swift
Code Issues Proposed changes

Add OPTIONS in manpages

Browse Source 
swift-account-info, swift-container-info, swift-object-info
and swift-get-node do not contain any information about the available
options. This patch adds OPTIONS in these manpages.

Change-Id: I832c621460ee6bf19adac8e0aadeab32be4b8da0
This commit is contained in:
Mohit Motiani 2016-10-25 21:13:55 +00:00 committed by Alistair Coles
parent 27ca0fb2a8
commit 243dd97c58
4 changed files with 69 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/manpages/swift-account-info.1
View File

@ -14,7 +14,7 @@
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
.\"
.TH swift-account-info 1 "3/22/2014" "Linux" "OpenStack Swift"
.TH swift-account-info 1 "10/25/2016" "Linux" "OpenStack Swift"
.SH NAME
.LP
@ -24,7 +24,7 @@
.SH SYNOPSIS
.LP
.B swift-account-info
[ACCOUNT_DB_FILE] [SWIFT_DIR]
[ACCOUNT_DB_FILE] [options]
.SH DESCRIPTION
.PP
@ -48,6 +48,15 @@ It will then return several information about that account such as;
.IP "- Ring Location"
.PD
.SH OPTIONS
.TP
\fB\-h, --help \fR
Shows the help message and exit
.TP
\fB\-d SWIFT_DIR, --swift-dir=SWIFT_DIR\fR
Pass location of swift configuration file if different from the default
location /etc/swift
.SH DOCUMENTATION
.LP
More documentation about OpenStack Swift can be found at

13
doc/manpages/swift-container-info.1
View File

@ -15,7 +15,7 @@
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
.\"
.TH swift-container-info 1 "3/20/2013" "Linux" "OpenStack Swift"
.TH swift-container-info 1 "10/25/2016" "Linux" "OpenStack Swift"
.SH NAME
.LP
@ -25,7 +25,7 @@
.SH SYNOPSIS
.LP
.B swift-container-info
[CONTAINER_DB_FILE] [SWIFT_DIR]
[CONTAINER_DB_FILE] [options]
.SH DESCRIPTION
.PP
@ -55,6 +55,15 @@ It will then return several information about that container such as;
.IP "- Location on the ring "
.PD
.SH OPTIONS
.TP
\fB\-h, --help \fR
Shows the help message and exit
.TP
\fB\-d SWIFT_DIR, --swift-dir=SWIFT_DIR\fR
Pass location of swift configuration file if different from the default
location /etc/swift
.SH DOCUMENTATION
.LP
More documentation about OpenStack Swift can be found at

32
doc/manpages/swift-get-nodes.1
View File

@ -15,7 +15,7 @@
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
.\"
.TH swift-get-nodes 1 "8/26/2011" "Linux" "OpenStack Swift"
.TH swift-get-nodes 1 "10/25/2016" "Linux" "OpenStack Swift"
.SH NAME
.LP
@ -25,7 +25,17 @@
.SH SYNOPSIS
.LP
.B swift-get-nodes
\ <ring.gz> <account> [<container> [<object>]]
\ [options] <ring.gz> <account> [<container> [<object>]]
Or
.B swift-get-nodes
[options] <ring.gz> -p <partition>
Or
.B swift-get-nodes
\ [options] -P policy_name <account> <container> <object>
.SH DESCRIPTION
.PP
@ -35,6 +45,24 @@ swift cluster nodes. For example, if you have the account hash and a container
name that belongs to that account, you can use swift-get-nodes to lookup
where the container resides by using the container ring.
.SH OPTIONS
.TP
\fB\-h --help \fR
Shows the help message and exit
.TP
\fB\-a, --all\fR
Show all handoff nodes
.TP
\fB\-p PARTITION, --partition=PARTITION\fR
Show nodes for a given partition
.TP
\fB\-P POLICY_NAME, --policy-name=POLICY_NAME \fR
Specify storage policy name
.TP
\fB\-d SWIFT_DIR, --swift-dir=SWIFT_DIR\fR
Pass location of swift configuration file if different from the default
location /etc/swift
.RS 0
.IP "\fIExample:\fR"
.RE

19
doc/manpages/swift-object-info.1
View File

@ -15,7 +15,7 @@
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
.\"
.TH swift-object-info 1 "8/26/2011" "Linux" "OpenStack Swift"
.TH swift-object-info 1 "10/25/2016" "Linux" "OpenStack Swift"
.SH NAME
.LP
@ -25,7 +25,7 @@
.SH SYNOPSIS
.LP
.B swift-object-info
[OBJECT_FILE] [SWIFT_DIR]
[OBJECT_FILE] [options]
.SH DESCRIPTION
.PP
@ -46,6 +46,21 @@ It will then return several information about that object such as;
.IP "- Location on the ring "
.PD
.SH OPTIONS
.TP
\fB\-h --help \fR
Shows the help message and exit
.TP
\fB\-n, --no-check-etag\fR
Don't verify file contents against stored etag
.TP
\fB\-d SWIFT_DIR, --swift-dir=SWIFT_DIR\fR
Pass location of swift configuration file if different from the default
location /etc/swift
.TP
\fB\-P POLICY_NAME, --policy-name=POLICY_NAME \fR
Specify storage policy name
.SH DOCUMENTATION
.LP
More documentation about OpenStack Swift can be found at