[lxc-devel] [pylxd/master] Update documetation
e1ee1e11 on Github
lxc-bot at linuxcontainers.org
Fri Jun 29 10:24:46 UTC 2018
A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 1138 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20180629/0344b4aa/attachment.bin>
-------------- next part --------------
From c541cc83701d29ee70f7ebe5a39754791a09f561 Mon Sep 17 00:00:00 2001
From: e1ee1e11 <e1ee1e11e1ee at gmail.com>
Date: Fri, 29 Jun 2018 15:52:25 +0800
Subject: [PATCH] Update documetation
Signed-off-by: e1ee1e11 <e1ee1e11e1ee at gmail.com>
---
doc/source/containers.rst | 1 +
doc/source/images.rst | 4 ++--
doc/source/operations.rst | 2 +-
3 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/doc/source/containers.rst b/doc/source/containers.rst
index dc4f287..c355302 100644
--- a/doc/source/containers.rst
+++ b/doc/source/containers.rst
@@ -173,6 +173,7 @@ A container object (returned by `get` or `all`) has the following methods:
To create a new snapshot, use `create` with a `name` argument. If you want
to capture the contents of RAM in the snapshot, you can use `stateful=True`.
+
.. note:: Your LXD requires a relatively recent version of CRIU for this.
.. code-block:: python
diff --git a/doc/source/images.rst b/doc/source/images.rst
index 6a23066..0011d65 100644
--- a/doc/source/images.rst
+++ b/doc/source/images.rst
@@ -19,7 +19,7 @@ methods:
And create through the following methods, there's also a copy method on an
image:
- - `create(data, public=False, wait=False)` - Create a new image. The first
+ - `create(data, public=False, wait=True)` - Create a new image. The first
argument is the binary data of the image itself. If the image is public,
set `public` to `True`.
- `create_from_simplestreams(server, alias, public=False, auto_update=False, wait=False)` -
@@ -93,7 +93,7 @@ you may also want to `wait=True`.
.. code-block:: python
- >>> image_data = open('an_image.tar.gz').read()
+ >>> image_data = open('an_image.tar.gz', 'rb').read()
>>> image = client.images.create(image_data, public=True, wait=True)
>>> image.fingerprint
'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'
diff --git a/doc/source/operations.rst b/doc/source/operations.rst
index eba3754..900e739 100644
--- a/doc/source/operations.rst
+++ b/doc/source/operations.rst
@@ -13,7 +13,7 @@ Manager methods
Operations can be queried through the following client manager methods:
- - `get()` - Get a specific network, by its name.
+ - `get()` - Get a specific operation, by its id.
- `wait_for_operation()` - get an operation, but wait until it is complete
before returning the operation object.
More information about the lxc-devel
mailing list