summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2016-06-06 10:33:25 +0000
committerGerrit Code Review <review@openstack.org>2016-06-06 10:33:25 +0000
commitc91c8d575e86b480270f8dfb7df49355dd38ee54 (patch)
treeee60b5dfa7a88a2e607c02f84a885ac4b1fa99d2 /doc
parente1e2678cd0a99955c280a813e10c6ce7494389cd (diff)
parent69bf4634b972ef2ee0ec1f015d71223203f0bb1a (diff)
downloadpython-swiftclient-c91c8d575e86b480270f8dfb7df49355dd38ee54.tar.gz
Merge "Add an option: disable etag check on downloads"
Diffstat (limited to 'doc')
-rw-r--r--doc/manpages/swift.11
-rw-r--r--doc/source/cli.rst3
-rw-r--r--doc/source/service-api.rst3
3 files changed, 6 insertions, 1 deletions
diff --git a/doc/manpages/swift.1 b/doc/manpages/swift.1
index b9f99c4..575adbe 100644
--- a/doc/manpages/swift.1
+++ b/doc/manpages/swift.1
@@ -86,6 +86,7 @@ container, or a list of objects depending on the args given. For a single
object download, you may use the \-o [\-\-output] <filename> option to
redirect the output to a specific file or if "-" then just redirect to stdout or
with \-\-no-download actually not to write anything to disk.
+The \-\-ignore-checksum is an option that turn off checksum validation.
You can specify optional headers with the repeatable cURL-like option
\-H [\-\-header]. For more details and options see swift download \-\-help.
.RE
diff --git a/doc/source/cli.rst b/doc/source/cli.rst
index 12de02f..bbbfa3d 100644
--- a/doc/source/cli.rst
+++ b/doc/source/cli.rst
@@ -186,7 +186,8 @@ Download
container, or a list of objects depending on the arguments given. For a
single object download, you may use the ``-o <filename>`` or ``--output <filename>``
option to redirect the output to a specific file or ``-`` to
- redirect to stdout. You can specify optional headers with the repeatable
+ redirect to stdout. The ``--ignore-checksum`` is an option that turn off
+ checksum validation. You can specify optional headers with the repeatable
cURL-like option ``-H [--header <name:value>]``.
Delete
diff --git a/doc/source/service-api.rst b/doc/source/service-api.rst
index 50dd80e..d165e5e 100644
--- a/doc/source/service-api.rst
+++ b/doc/source/service-api.rst
@@ -207,6 +207,9 @@ Options
Affects uploads, and allows empty 'pseudofolder' objects to be created
when the source of an upload is ``None``.
+ ``checksum``: ``True``
+ Affects uploads and downloads, and means if check md5 for downloads/uploads.
+
``shuffle``: ``False``
When downloading objects, the default behaviour of the CLI is to shuffle
lists of objects in order to spread the load on storage drives when multiple