openstack/swift
Code Issues Proposed changes

Removed whitespaces from swift-ring-builder manpage

Browse Source 
Change-Id: I25cf69f8d963ba84df4c59129d72ee39ec341bd3
This commit is contained in:
Mohit Motiani 2016-06-07 19:08:50 +00:00
parent c40de1cbc8
commit 334140a543
1 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
doc/manpages/swift-ring-builder.1
View File

@ -14,10 +14,10 @@
.\" implied.
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
.\"
.\"
.TH swift-ring-builder 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME
.SH NAME
.LP
.B swift-ring-builder
\- Openstack-swift ring builder
@ -27,13 +27,13 @@
.B swift-ring-builder
<builder_file> <commands> <arguments> <...>
.SH DESCRIPTION
.SH DESCRIPTION
.PP
The swift-ring-builder utility is used to create, search and manipulate
the swift storage ring. The ring-builder assigns partitions to devices and
The swift-ring-builder utility is used to create, search and manipulate
the swift storage ring. The ring-builder assigns partitions to devices and
writes an optimized Python structure to a gzipped, pickled file on disk for
shipping out to the servers. The server processes just check the modification
time of the file occasionally and reload their in-memory copies of the ring
shipping out to the servers. The server processes just check the modification
time of the file occasionally and reload their in-memory copies of the ring
structure as needed. Because of how the ring-builder manages changes to the
ring, using a slightly older ring usually just means one of the three replicas
for a subset of the partitions will be incorrect, which can be easily worked around.
@ -59,7 +59,7 @@ needs to interact with the rings manually.
.SH SEARCH
.PD 0
.PD 0
.IP "\fB<search-value>\fR"
.RS 5
@ -81,12 +81,12 @@ needs to interact with the rings manually.
.IP "[::1] Matches devices in any zone with the ip ::1"
.IP "z1-[::1]:5678 Matches devices in zone 1 with ip ::1 and port 5678"
.RE
Most specific example:
.RS 3
d74z1-1.2.3.4:5678/sdb1_"snet: 5.6.7.8"
.RE
d74z1-1.2.3.4:5678/sdb1_"snet: 5.6.7.8"
.RE
Nerd explanation:
@ -94,7 +94,7 @@ Nerd explanation:
.IP "All items require their single character prefix except the ip, in which case the - is optional unless the device id or zone is also included."
.RE
.RE
.PD
.PD
.SH OPTIONS
@ -104,12 +104,12 @@ Assume a yes response to all questions
.SH COMMANDS
.PD 0
.PD 0
.IP "\fB<builder_file>\fR"
.RS 5
Shows information about the ring and the devices within.
Shows information about the ring and the devices within.
.RE
@ -143,7 +143,7 @@ the devices matching the search values given. The first column is the
assigned partition number and the second column is the number of device
matches for that partition. The list is ordered from most number of matches
to least. If there are a lot of devices to match against, this command
could take a while to run.
could take a while to run.
.RE
@ -198,8 +198,8 @@ Just runs the validation routines on the ring.
.IP "\fBwrite_ring\fR"
.RS 5
Just rewrites the distributable ring file. This is done automatically after
a successful rebalance, so really this is only useful after one or more 'set_info'
Just rewrites the distributable ring file. This is done automatically after
a successful rebalance, so really this is only useful after one or more 'set_info'
calls when no rebalance is needed but you want to send out the new device information.
.RE
@ -208,18 +208,18 @@ calls when no rebalance is needed but you want to send out the new device inform
set_min_part_hours set_weight validate write_ring
\fBExit codes:\fR 0 = ring changed, 1 = ring did not change, 2 = error
.PD
.PD
.SH DOCUMENTATION
.LP
More in depth documentation about the swift ring and also Openstack-Swift as a
whole can be found at
.BI http://swift.openstack.org/overview_ring.html,
.BI http://swift.openstack.org/admin_guide.html#managing-the-rings
and
More in depth documentation about the swift ring and also Openstack-Swift as a
whole can be found at
.BI http://swift.openstack.org/overview_ring.html,
.BI http://swift.openstack.org/admin_guide.html#managing-the-rings
and
.BI http://swift.openstack.org