Browse Source

ETCDCTL: value can not be provided after \r

Document that etcdctl do not support providing value after using \r and that multiple lines
or spaces requires to be double-quoted.

Fixed #9937
Sahdev P. Zala 7 years ago
parent
commit
b43fdbcfa4
1 changed files with 13 additions and 0 deletions
  1. 13 0
      etcdctl/README.md

+ 13 - 0
etcdctl/README.md

@@ -81,6 +81,19 @@ Insert '--' for workaround:
 ./etcdctl put -- <key> <value>
 ```
 
+Providing \<value\> in a new line after using `carriage return` is not supported and etcdctl may hang in that case. For example, following case is not supported:
+
+```bash
+./etcdctl put <key>\r
+<value>
+```
+
+A \<value\> can have multiple lines or spaces but it must be provided with a double-quote as demonstrated below:
+
+```bash
+./etcdctl put foo "bar1 2 3"
+```
+
 ### GET [options] \<key\> [range_end]
 
 GET gets the key or a range of keys [key, range_end) if range_end is given.