11 Commits

Author SHA1 Message Date
junboli
6998d804ff doc migration: update the doc link address[1/3]
Update the doc link brought by the swift doc migration.
Although we had some effort to fix these before, it still left lots
of bad doc link, I separate these changes into 3 patches aim to fix
all of these, this is the 1st patch for doc/manpages.

Change-Id: Ib49696706e61bbd36ae56b15b1d94aa4ce84531c
2017-09-05 19:13:47 +00:00
Monty Taylor
3c844d02b9
Replace references to swift.openstack.org
The policy of giving projects vanity domains stopped about 5 years ago.
swift.openstack.org is a redirect to the canonical location -
docs.openstack.org/developer/swift. While we are not aiming to remove
the redirect any time in the forseeable future due to existing published
links pointing to it, we should at the very least stop adding more of
those links to the world.

Change-Id: I10e92309f5d3b5f908fe4438f5cc0b184f161cba
2017-03-08 09:46:41 -06:00
Shashirekha Gundur
c5ff9932a4 NIT: fixing inconsistent naming of OpenStack Swift
Throughout the manpages maintaining references to OpenStack Swift.

Change-Id: I2a0c2658e10a92671bfc092c0a3abaddfd8cd7d9
Closes-Bug: #1609687
2016-08-05 13:58:25 +00:00
Mohit Motiani
6c9a1899a1 Adds region as a search-value in manpage
This patch adds region and example related to it in the man page
of swift-ring-builder.

Change-Id: I12ceab4e41240240cf2daa77dad94729dd1fd76d
2016-06-10 11:56:07 -07:00
Mohit Motiani
334140a543 Removed whitespaces from swift-ring-builder manpage
Change-Id: I25cf69f8d963ba84df4c59129d72ee39ec341bd3
2016-06-07 19:13:34 +00:00
Ondřej Nový
a54095e562 swift-ring-builder --yes option
This option assume a yes response to all questions. It is usefull for
scripts.

Change-Id: I28ca1a44507e0f1265afd36e6ac1e7c6c176428f
2016-05-31 17:11:13 +02:00
Pete Zaitcev
0b20a18e52 Spell "rebalance" right in swift-ring-builder.1
See Red Hat bug #1218269.

Change-Id: I814eb4b3c0821f5a8df5feea2bda3a964aace536
2015-05-07 13:17:15 -06:00
Samuel Merritt
d69f929be9 Add "normal", optparse-style options to swift-ring-builder add.
The old format is still present and works just like it did before, so
your existing scripts won't break.

New format pros:
 * it's readable even for Swift newcomers
 * it's easy to extend
 * it's familiar to anyone who's used a Unix command line
 * we don't have to maintain the parser

New format cons:
 * you can't add multiple devices in one go

Old format pros:
 * you can add many devices with one command
 * it's compact

Old format cons:
 * it confuses newcomers
 * "wait, is that zone dash IP colon port slash device, or zone slash
   IP dash port colon meta underscore device?" Just try walking
   someone through adding a device over voice chat.
 * it's annoying to add new fields

Note that this only affects the command "swift-ring-builder
<builderfile> add". Other swift-ring-builder commands are unchanged.

DocImpact

Change-Id: I034b7f79eb6f4d81a5c4da193e1358741441c5b5
2013-06-10 14:09:27 -07:00
annegentle
72428434f7 Replaces Copyright statements for LLC with Foundation, removes date.
Replaced GA code for cross-domain tracking.

Patchset addresses reviewer's comments
and follows new guidance from Foundation:
http://wiki.openstack.org/Documentation/Copyright

Adds current year to each Sphinx-built page.

Addresses only the docs copyright attribution, not code files.

Change-Id: Ib90fd1c92c8fafce2db821bc2b17cef1377cfc1e
2013-02-11 16:32:33 -06:00
Florian Hines
00dbad0825 Add optional locking to swift-ring-builder
If invoked as 'swift-ring-builder-safe' the directory containing the builder
file provided will be locked (via lock_parent_directory()). This provides a
small safe guard against multiple instances of the swift-ring-builder (or
other utilities that observe this lock) from attempting to write to or read
the builder/ring files while operations are in progress.

This is particularly useful in environments where ring management has been
automated (via Chef or custom solutions) but the operator still occasionally
needs to manually interact with the ring.

DocImpact

Change-Id: Ia362744a8151a91bfb586d01da582906726852e6
2013-01-25 08:00:33 -08:00
Marcelo Martins
0b0785e984 changing config files to be on section 5 and also running spellchecks against all files
"Also adding the new swift-recon and swift-ring-builder manpages to this set"
"Adding new manpages for configuration files and also making changes according to previous review suggestions"
"removing the Author line from the manpages according to suggestions"

Change-Id: I256d2b2851b55a379b59011894f214bf55ba7da9
2011-11-08 21:09:42 -06:00