summaryrefslogtreecommitdiff
path: root/doc/source/cli/index.rst
diff options
context:
space:
mode:
authorTim Burke <tim.burke@gmail.com>2019-08-01 21:07:43 -0700
committerTim Burke <tim.burke@gmail.com>2019-08-07 12:17:38 -0700
commit12bd870a02fc3528f45d27152c62fb0b9598bc84 (patch)
treed9f236af435fa58e8c11dafc054dfa083f2b1232 /doc/source/cli/index.rst
parent093ee55c2be77fb53deab81fa7faf31ebfc39647 (diff)
downloadpython-swiftclient-12bd870a02fc3528f45d27152c62fb0b9598bc84.tar.gz
Fix up stable gate
This is a combination of three commits from master: --- Isolate docs requirements ...since modern sphinx won't install on py27. While we're at it, clean up some warnings and treat warnings as errors. Also, fix up how we parse test configs so we can run func tests. Related-Change: Id3c2ed87230c5918c18e2c01d086df8157f036b1 (cherry picked from commit 113eacf3b80f61d366b3e95b558b40f82ff728a4) --- Drag forward prettytable in lower-constraints Apparently version 0.7 got unpublished recently. (cherry picked from commit 5bd66947fc3d8987d4b24d5119a346031004229e) --- docs: Clean up formatting (cherry-picked from commit 7563d9cb5642c85a31708fd863e2737f9d6c9419) --- Change-Id: I3c6bca460ee5ff99195495a29e8b8bbf4ed804ff (cherry picked from commit 172aa9016977a3b03f07da0350c6aa9ade1e55a0)
Diffstat (limited to 'doc/source/cli/index.rst')
-rw-r--r--doc/source/cli/index.rst40
1 files changed, 17 insertions, 23 deletions
diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst
index 88fafa1..d6841d5 100644
--- a/doc/source/cli/index.rst
+++ b/doc/source/cli/index.rst
@@ -245,13 +245,10 @@ storage URL options shown below:
--os-storage-url https://10.1.5.2:8080/v1/AUTH_ced809b6a4baea7aeab61a \
list
-.. We need the backslash below in order to indent the note
-\
+.. note::
- .. note::
-
- Leftover environment variables are a common source of confusion when
- authorization fails.
+ Leftover environment variables are a common source of confusion when
+ authorization fails.
CLI commands
~~~~~~~~~~~~
@@ -739,15 +736,15 @@ is passed, the Unix timestamp when the temporary URL will expire.
But beyond that, ``time`` can also be specified as an ISO 8601 timestamp
in one of following formats:
- i) Complete date: YYYY-MM-DD (eg 1997-07-16)
+i) Complete date: YYYY-MM-DD (e.g. 1997-07-16)
- ii) Complete date plus hours, minutes and seconds:
- YYYY-MM-DDThh:mm:ss
- (eg 1997-07-16T19:20:30)
+ii) Complete date plus hours, minutes and seconds:
+ YYYY-MM-DDThh:mm:ss
+ (e.g. 1997-07-16T19:20:30)
- iii) Complete date plus hours, minutes and seconds with UTC designator:
- YYYY-MM-DDThh:mm:ssZ
- (eg 1997-07-16T19:20:30Z)
+iii) Complete date plus hours, minutes and seconds with UTC designator:
+ YYYY-MM-DDThh:mm:ssZ
+ (e.g. 1997-07-16T19:20:30Z)
Please be aware that if you don't provide the UTC designator (i.e., Z)
the timestamp is generated using your local timezone. If only a date is
@@ -881,17 +878,14 @@ Download an object from a container:
testSwift.txt [auth 0.028s, headers 0.045s, total 0.045s, 0.002 MB/s]
-.. We need the backslash below in order to indent the note
-\
-
- .. note::
+.. note::
- To upload an object to a container, your current working directory must be
- where the file is located or you must provide the complete path to the file.
- In other words, the --object-name <object-name> is an option that will upload
- file and name object to <object-name> or upload directory and use <object-name> as
- object prefix. In the case that you provide the complete path of the file,
- that complete path will be the name of the uploaded object.
+ To upload an object to a container, your current working directory must be
+ where the file is located or you must provide the complete path to the file.
+ In other words, the --object-name <object-name> is an option that will upload
+ file and name object to <object-name> or upload directory and use <object-name> as
+ object prefix. In the case that you provide the complete path of the file,
+ that complete path will be the name of the uploaded object.
For example: