aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorEwan Mellor <ewan@xensource.com>2007-01-29 12:11:13 +0000
committerEwan Mellor <ewan@xensource.com>2007-01-29 12:11:13 +0000
commit22309ac5669d3b97cba5571afe8398561b3fcde5 (patch)
tree09b28baeb8abb2731fcad62d17b3fa859168bfe2 /docs
parentfbe0a458864b8ac3938845eacf85ce3bbc9cb597 (diff)
downloadxen-22309ac5669d3b97cba5571afe8398561b3fcde5.tar.gz
xen-22309ac5669d3b97cba5571afe8398561b3fcde5.tar.bz2
xen-22309ac5669d3b97cba5571afe8398561b3fcde5.zip
Rename VM.otherConfig to VM.other_config, for consistency with the other fields,
and implement add_to_other_config and remove_from_other_config in the C bindings. Signed-off-by: Ewan Mellor <ewan@xensource.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/xen-api/xenapi-datamodel.tex27
1 files changed, 14 insertions, 13 deletions
diff --git a/docs/xen-api/xenapi-datamodel.tex b/docs/xen-api/xenapi-datamodel.tex
index 15c27e9c8d..821ba54685 100644
--- a/docs/xen-api/xenapi-datamodel.tex
+++ b/docs/xen-api/xenapi-datamodel.tex
@@ -1122,7 +1122,7 @@ $\mathit{RW}$ & {\tt platform/clock\_offset} & bool & timeshift applied to gues
$\mathit{RW}$ & {\tt platform/enable\_audio} & bool & emulate audio \\
$\mathit{RO}_\mathit{ins}$ & {\tt PCI\_bus} & string & PCI bus path for pass-through devices \\
$\mathit{RO}_\mathit{run}$ & {\tt tools\_version} & (string $\rightarrow$ string) Map & versions of installed paravirtualised drivers \\
-$\mathit{RW}$ & {\tt otherConfig} & (string $\rightarrow$ string) Map & additional configuration \\
+$\mathit{RW}$ & {\tt other\_config} & (string $\rightarrow$ string) Map & additional configuration \\
\hline
\end{longtable}
\subsection{Additional RPCs associated with class: VM}
@@ -3895,13 +3895,13 @@ value of the field
\vspace{0.3cm}
\vspace{0.3cm}
\vspace{0.3cm}
-\subsubsection{RPC name:~get\_otherConfig}
+\subsubsection{RPC name:~get\_other\_config}
{\bf Overview:}
-Get the otherConfig field of the given VM.
+Get the other\_config field of the given VM.
\noindent {\bf Signature:}
-\begin{verbatim} ((string -> string) Map) get_otherConfig (session_id s, VM ref self)\end{verbatim}
+\begin{verbatim} ((string -> string) Map) get_other_config (session_id s, VM ref self)\end{verbatim}
\noindent{\bf Arguments:}
@@ -3927,13 +3927,13 @@ value of the field
\vspace{0.3cm}
\vspace{0.3cm}
\vspace{0.3cm}
-\subsubsection{RPC name:~set\_otherConfig}
+\subsubsection{RPC name:~set\_other\_config}
{\bf Overview:}
-Set the otherConfig field of the given VM.
+Set the other\_config field of the given VM.
\noindent {\bf Signature:}
-\begin{verbatim} void set_otherConfig (session_id s, VM ref self, (string -> string) Map value)\end{verbatim}
+\begin{verbatim} void set_other_config (session_id s, VM ref self, (string -> string) Map value)\end{verbatim}
\noindent{\bf Arguments:}
@@ -3961,13 +3961,13 @@ void
\vspace{0.3cm}
\vspace{0.3cm}
\vspace{0.3cm}
-\subsubsection{RPC name:~add\_to\_otherConfig}
+\subsubsection{RPC name:~add\_to\_other\_config}
{\bf Overview:}
-map add message derived from field otherConfig of object VM
+Add the given key-value pair to the other\_config field of the given VM.
\noindent {\bf Signature:}
-\begin{verbatim} void add_to_otherConfig (session_id s, VM ref self, string key, string value)\end{verbatim}
+\begin{verbatim} void add_to_other_config (session_id s, VM ref self, string key, string value)\end{verbatim}
\noindent{\bf Arguments:}
@@ -3997,13 +3997,14 @@ void
\vspace{0.3cm}
\vspace{0.3cm}
\vspace{0.3cm}
-\subsubsection{RPC name:~remove\_from\_otherConfig}
+\subsubsection{RPC name:~remove\_from\_other\_config}
{\bf Overview:}
-map remove message derived from field otherConfig of object VM
+Remove the given key and its corresponding value from the other\_config
+field of the given VM. If the key is not in that Map, then do nothing.
\noindent {\bf Signature:}
-\begin{verbatim} void remove_from_otherConfig (session_id s, VM ref self, string key)\end{verbatim}
+\begin{verbatim} void remove_from_other_config (session_id s, VM ref self, string key)\end{verbatim}
\noindent{\bf Arguments:}