summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristopher Bartz <bartz@dkrz.de>2017-07-06 17:30:48 +0200
committerTim Burke <tim.burke@gmail.com>2017-07-06 10:19:12 -0700
commitcde73c196d4f161b227fb924cd59cf02eaa33c03 (patch)
tree6e4314a1d68974f4f00ab90b7162ab83e33f9e6b /doc
parent1d57403668815ab8cef9d6598c06bf1c7e5355c0 (diff)
downloadpython-swiftclient-cde73c196d4f161b227fb924cd59cf02eaa33c03.tar.gz
Option to ignore mtime metadata entry.
Currently, the swiftclient upload command passes a custom metadata header for each object (called object-meta-mtime), whose value is the current UNIX timestamp. When downloading such an object with the swiftclient, the mtime header is parsed and passed as the atime and mtime for the newly created file. There are use-cases where this is not desired, for example when using tmp or scratch directories in which files older than a specific date are deleted. This commit provides a boolean option for ignoring the mtime header. Change-Id: If60b389aa910c6f1969b999b5d3b6d0940375686
Diffstat (limited to 'doc')
-rw-r--r--doc/manpages/swift.13
-rw-r--r--doc/source/cli.rst4
2 files changed, 6 insertions, 1 deletions
diff --git a/doc/manpages/swift.1 b/doc/manpages/swift.1
index 1f288d6..d44a7d5 100644
--- a/doc/manpages/swift.1
+++ b/doc/manpages/swift.1
@@ -102,6 +102,9 @@ with \-\-no-download actually not to write anything to disk.
The \-\-ignore-checksum is an option that turns 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.
+The \-\-ignore\-mtime option ignores the x\-object\-meta\-mtime metadata entry
+on the object (if present) and instead creates the downloaded files with
+fresh atime and mtime values.
.RE
\fBdelete\fR [\fIcommand-options\fR] [\fIcontainer\fR] [\fIobject\fR] [\fIobject\fR] [...]
diff --git a/doc/source/cli.rst b/doc/source/cli.rst
index 8d80d1b..8df95aa 100644
--- a/doc/source/cli.rst
+++ b/doc/source/cli.rst
@@ -188,7 +188,9 @@ Download
option to redirect the output to a specific file or ``-`` to
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>]``.
+ cURL-like option ``-H [--header <name:value>]``. ``--ignore-mtime`` ignores the
+ ``x-object-meta-mtime`` metadata entry on the object (if present) and instead
+ creates the downloaded files with fresh atime and mtime values.
Delete
------