openstack/swift
Code Issues Proposed changes

Show file parameters as mandatory in swift-*-info man pages

Browse Source 
Changes the file parameters on command line to use the convention of
<file> for a mandatory option rather than [file] which suggests an
optional flag. Also drop to lower case as is convention in other man
pages.

Change-Id: Icfb4b4786343eb493a73b092cad1fdadc935d066
This commit is contained in:
Alistair Coles 2016-11-11 16:34:15 +00:00
parent 243dd97c58
commit 721cd1634a
3 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -24,7 +24,7 @@
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-account-info .B swift-account-info
[ACCOUNT_DB_FILE] [options] <account_db_file> [options]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP

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

@ -25,7 +25,7 @@
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-container-info .B swift-container-info
[CONTAINER_DB_FILE] [options] <container_db_file> [options]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP

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

@ -25,7 +25,7 @@
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-object-info .B swift-object-info
[OBJECT_FILE] [options] <object_file> [options]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP