mirror
/
etcd-cpp-apiv3
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update rmdir description.

This commit is contained in:
Arches 2016-06-23 17:32:22 +02:00
parent fb5222a7b5
commit 8a55c6e49a
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -229,13 +229,15 @@ response.value(i)```.
3. Removing directory: 3. Removing directory:
If you want the delete recursively then you have to pass a second ```true``` parameter If you want the delete recursively then you have to pass a second ```true``` parameter
to rmdir and supply a prefix. All keys that match the prefix will to rmdir and supply a key. This key will be treated as a prefix. All keys that match the prefix will
be deleted. This parameter defaults to ```false```. be deleted. This parameter defaults to ```false```.
```c++ ```c++
etcd::Client etcd("http://127.0.0.1:4001"); etcd::Client etcd("http://127.0.0.1:4001");
etcd.rmdir("/test", true).get(); etcd.rmdir("/test", true).get();
``` ```
However, if recursive parameter is false, functionality will be the same as just deleting a key.
The key supplied will NOT be treated as a prefix and will be treated as a normal key name.
### watching for changes ### watching for changes