From 6f4a2e9d8d60f31a5327716194dea0979d430ce7 Mon Sep 17 00:00:00 2001
From: Andrea Spadaccini <spadaccio@google.com>
Date: Tue, 13 Sep 2011 14:12:01 +0100
Subject: [PATCH] Fix RAPI documentation for gnt-instance console
Fix a failing pyassert in the RAPI docs and update it to reflect the
addition of SPICE to gnt-instance console.
Signed-off-by: Andrea Spadaccini <spadaccio@google.com>
Reviewed-by: Michael Hanselmann <hansmi@google.com>
---
doc/rapi.rst | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/doc/rapi.rst b/doc/rapi.rst
index 7ed29a803..5a00dddcb 100644
--- a/doc/rapi.rst
+++ b/doc/rapi.rst
@@ -977,20 +977,23 @@ console. Contained keys:
constants.CONS_MESSAGE,
constants.CONS_SSH,
constants.CONS_VNC,
+ constants.CONS_SPICE,
])
``instance``
Instance name.
``kind``
Console type, one of :pyeval:`constants.CONS_SSH`,
- :pyeval:`constants.CONS_VNC` or :pyeval:`constants.CONS_MESSAGE`.
+ :pyeval:`constants.CONS_VNC`, :pyeval:`constants.CONS_SPICE`
+ or :pyeval:`constants.CONS_MESSAGE`.
``message``
Message to display (:pyeval:`constants.CONS_MESSAGE` type only).
``host``
- Host to connect to (:pyeval:`constants.CONS_SSH` and
- :pyeval:`constants.CONS_VNC` only).
+ Host to connect to (:pyeval:`constants.CONS_SSH`,
+ :pyeval:`constants.CONS_VNC` or :pyeval:`constants.CONS_SPICE` only).
``port``
- TCP port to connect to (:pyeval:`constants.CONS_VNC` only).
+ TCP port to connect to (:pyeval:`constants.CONS_VNC` or
+ :pyeval:`constants.CONS_SPICE` only).
``user``
Username to use (:pyeval:`constants.CONS_SSH` only).
``command``
--
GitLab