aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKeir Fraser <keir.fraser@citrix.com>2009-07-24 12:08:54 +0100
committerKeir Fraser <keir.fraser@citrix.com>2009-07-24 12:08:54 +0100
commitc391d9bd062a0e5c6cd0d3376ad5c669fc4da733 (patch)
tree0a3acf36512880e701b3385a4366cde59c4926e0 /docs
parentd714f7b5af71982b5297ac14a98ea23b29f87fd9 (diff)
downloadxen-c391d9bd062a0e5c6cd0d3376ad5c669fc4da733.tar.gz
xen-c391d9bd062a0e5c6cd0d3376ad5c669fc4da733.tar.bz2
xen-c391d9bd062a0e5c6cd0d3376ad5c669fc4da733.zip
Revert 19961: breaks xend start on some systems.
Signed-off-by: Keir Fraser <keir.fraser@citrix.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/xen-api/bibliography.tex5
-rw-r--r--docs/xen-api/revision-history.tex58
-rw-r--r--docs/xen-api/xenapi-coversheet.tex4
-rw-r--r--docs/xen-api/xenapi-datamodel.tex91
-rw-r--r--docs/xen-api/xenapi.tex2
5 files changed, 45 insertions, 115 deletions
diff --git a/docs/xen-api/bibliography.tex b/docs/xen-api/bibliography.tex
deleted file mode 100644
index 30df3875b2..0000000000
--- a/docs/xen-api/bibliography.tex
+++ /dev/null
@@ -1,5 +0,0 @@
-\begin{thebibliography}{9}
-\bibitem[RFC2397]{RFC2397}
-Masinter L., \textbf{The "data" URL scheme}, RFC 2397, August 1998,
-Network Working Group, http://www.ietf.org/rfc/rfc2397.txt
-\end{thebibliography}
diff --git a/docs/xen-api/revision-history.tex b/docs/xen-api/revision-history.tex
index ef214af16c..2e41b38581 100644
--- a/docs/xen-api/revision-history.tex
+++ b/docs/xen-api/revision-history.tex
@@ -1,49 +1,69 @@
{ \bf Revision History}
-% Please do not use minipages in a tabular environment; this results
-% in bad vertical alignment.
-
-\begin{flushleft}
\begin{center}
- \begin{tabular}{|l|l|l|>{\raggedright}p{7cm}|}
+ \begin{tabular}{|l|l|l|l|}
\hline
1.0.0 & 27th April 07 & Xensource et al. &
- Initial Revision\tabularnewline
+ \begin{minipage}[t][.7cm]{7cm}
+ Initial Revision
+ \end{minipage}\\
\hline
1.0.1 & 10th Dec. 07 & S. Berger &
+ \begin{minipage}[t]{7cm}
+ \begin{flushleft}
Added XSPolicy.reset\_xspolicy, VTPM.get\_other\_config,
- VTPM.set\_otherconfig. ACMPolicy.get\_enforced\_binary methods.\tabularnewline
+ VTPM.set\_otherconfig. ACMPolicy.get\_enforced\_binary methods.
+ \end{flushleft}
+ \end{minipage}\\
\hline
1.0.2 & 25th Jan. 08 & J. Fehlig &
- Added Crashed VM power state.\tabularnewline
+ \begin{minipage}[t]{7cm}
+ \begin{flushleft}
+ Added Crashed VM power state.
+ \end{flushleft}
+ \end{minipage}\\
\hline
1.0.3 & 11th Feb. 08 & S. Berger &
- Added table of contents and hyperlink cross reference.\tabularnewline
+ \begin{minipage}[t]{7cm}
+ \begin{flushleft}
+ Added table of contents and hyperlink cross reference.
+ \end{flushleft}
+ \end{minipage}\\
\hline
1.0.4 & 23rd March 08 & S. Berger &
- Added XSPolicy.can\_run\tabularnewline
+ \begin{minipage}[t]{7cm}
+ \begin{flushleft}
+ Added XSPolicy.can\_run
+ \end{flushleft}
+ \end{minipage}\\
\hline
1.0.5 & 17th Apr. 08 & S. Berger &
+ \begin{minipage}[t]{7cm}
+ \begin{flushleft}
Added undocumented fields and methods for default\_netmask and
default\_gateway to the Network class. Removed an unimplemented
method from the XSPolicy class and removed the 'optional' from
- 'oldlabel' parameters.\tabularnewline
+ 'oldlabel' parameters.
+ \end{flushleft}
+ \end{minipage}\\
\hline
1.0.6 & 24th Jul. 08 & Y. Iwamatsu &
+ \begin{minipage}[t]{7cm}
+ \begin{flushleft}
Added definitions of new classes DPCI and PPCI. Updated the table
and the diagram representing relationships between classes.
- Added host.PPCIs and VM.DPCIs fields.\tabularnewline
+ Added host.PPCIs and VM.DPCIs fields.
+ \end{flushleft}
+ \end{minipage}\\
\hline
1.0.7 & 20th Oct. 08 & M. Kanno &
+ \begin{minipage}[t]{7cm}
+ \begin{flushleft}
Added definitions of new classes DSCSI and PSCSI. Updated the table
and the diagram representing relationships between classes.
- Added host.PSCSIs and VM.DSCSIs fields.\tabularnewline
- \hline
- 1.0.8 & 17th Jun. 09 & A. Florath &
- Updated interactive session example.
- Added description for \texttt{PV/kernel} and \texttt{PV/ramdisk}
- parameters using URIs.\tabularnewline
+ Added host.PSCSIs and VM.DSCSIs fields.
+ \end{flushleft}
+ \end{minipage}\\
\hline
\end{tabular}
\end{center}
-\end{flushleft}
diff --git a/docs/xen-api/xenapi-coversheet.tex b/docs/xen-api/xenapi-coversheet.tex
index 42b4ebd07b..231afed091 100644
--- a/docs/xen-api/xenapi-coversheet.tex
+++ b/docs/xen-api/xenapi-coversheet.tex
@@ -17,12 +17,12 @@
\newcommand{\coversheetlogo}{xen.eps}
%% Document date
-\newcommand{\datestring}{17th June 2009}
+\newcommand{\datestring}{20th October 2008}
\newcommand{\releasestatement}{Stable Release}
%% Document revision
-\newcommand{\revstring}{API Revision 1.0.8}
+\newcommand{\revstring}{API Revision 1.0.7}
%% Document authors
\newcommand{\docauthors}{
diff --git a/docs/xen-api/xenapi-datamodel.tex b/docs/xen-api/xenapi-datamodel.tex
index fb76ade6bf..6eb2a41e06 100644
--- a/docs/xen-api/xenapi-datamodel.tex
+++ b/docs/xen-api/xenapi-datamodel.tex
@@ -1,6 +1,5 @@
%
% Copyright (c) 2006-2007 XenSource, Inc.
-% Copyright (c) 2009 flonatel GmbH & Co. KG
%
% Permission is granted to copy, distribute and/or modify this document under
% the terms of the GNU Free Documentation License, Version 1.2 or any later
@@ -10,7 +9,6 @@
% "GNU Free Documentation License" or the file fdl.tex.
%
% Authors: Ewan Mellor, Richard Sharp, Dave Scott, Jon Harrop.
-% Contributor: Andreas Florath
%
\chapter{API Reference}
@@ -1380,10 +1378,10 @@ the batch of events
\newpage
\section{Class: VM}
\subsection{Fields for class: VM}
-\begin{longtable}{|llp{0.21\textwidth}p{0.33\textwidth}|}
+\begin{longtable}{|lllp{0.38\textwidth}|}
\hline
\multicolumn{1}{|l}{Name} & \multicolumn{3}{l|}{\bf VM} \\
-\multicolumn{4}{|l|}{\parbox{11cm}{\em Description: A
+\multicolumn{1}{|l}{Description} & \multicolumn{3}{l|}{\parbox{11cm}{\em A
virtual machine (or 'guest').}} \\
\hline
Quals & Field & Type & Description \\
@@ -1415,8 +1413,8 @@ $\mathit{RO}_\mathit{run}$ & {\tt VTPMs} & (VTPM ref) Set & virtual TPMs \\
$\mathit{RO}_\mathit{run}$ & {\tt DPCIs} & (DPCI ref) Set & pass-through PCI devices \\
$\mathit{RO}_\mathit{run}$ & {\tt DSCSIs} & (DSCSI ref) Set & half-virtualized SCSI devices \\
$\mathit{RW}$ & {\tt PV/bootloader} & string & name of or path to bootloader \\
-$\mathit{RW}$ & {\tt PV/kernel} & string & URI of kernel \\
-$\mathit{RW}$ & {\tt PV/ramdisk} & string & URI of initrd \\
+$\mathit{RW}$ & {\tt PV/kernel} & string & path to the kernel \\
+$\mathit{RW}$ & {\tt PV/ramdisk} & string & path to the initrd \\
$\mathit{RW}$ & {\tt PV/args} & string & kernel command-line arguments \\
$\mathit{RW}$ & {\tt PV/bootloader\_args} & string & miscellaneous arguments for the bootloader \\
$\mathit{RW}$ & {\tt HVM/boot\_policy} & string & HVM boot policy \\
@@ -1431,87 +1429,6 @@ $\mathit{RO}_\mathit{run}$ & {\tt guest\_metrics} & VM\_guest\_metrics ref & me
$\mathit{RO}_\mathit{run}$ & {\tt security/label} & string & the VM's security label \\
\hline
\end{longtable}
-\subsection{Parameter Details}
-\subsubsection{PV/kernel and PV/ramdisk}
-The \texttt{PV/kernel} and \texttt{PV/ramdisk} parameters should be
-specified as URIs with either a \texttt{file} or \texttt{data} scheme.
-
-The \texttt{file} scheme must be used when a file on the remote dom0
-should be used. The remote dom0 is the one where the guest system
-should be started on. Only absolute filenames are supported, i.e. the
-string must start with \texttt{file://} appended with the absolute
-path. This is typically used when the guest system use the same
-operating systems as the dom0 or there is some kind of shared storage
-for the images inside the dom0s.
-
-Note that for compatibility reasons it is possible --- but not
-recommended --- to leave out the scheme specification for
-\texttt{file}, i.e. \texttt{file:///some/path} and \texttt{/some/path}
-is equivalent.
-
-Examples (in python):
-
-Use kernel image which resides in the \texttt{/boot} directory:
-\begin{verbatim}
-xenapi.VM.create({ ...
- 'PV_kernel': 'file:///boot/vmlinuz-2.6.26-2-xen-686',
- ... })
-\end{verbatim}
-
-Use ramdisk image which resides on a (shared) nfs directory:
-\begin{verbatim}
-xenapi.VM.create({ ...
- 'PV_ramdisk': 'file:///nfs/xen/debian/5.0.1/initrd.img-2.6.26-2-xen-686'
- ... })
-\end{verbatim}
-
-When an image should be used which resides on the local system,
-i.e. the system where the XenAPI call is send from, it is possible to
-use the \texttt{data} URI scheme as described in \cite{RFC2397}. The
-media-type must be set to \texttt{application/octet-stream}.
-Currently only base64 encoding is supported. The URI must therefore
-start with \texttt{data:application/octet-stream;base64,} followed by
-the base64 encoded image.
-
-The \texttt{xen/util/fileuri.py} provides a helper function which
-takes a local filename as parameter and build up the correct URI from
-this.
-
-Examples (in python):
-
-Use kernel image specified inline:
-\begin{verbatim}
-xenapi.VM.create({ ...
- 'PV_kernel': 'data:application/octet-stream;base64,H4Zu....'
- # most of base64 encoded data is omitted
- ... })
-\end{verbatim}
-
-Using the utility function:
-\begin{verbatim}
-from xen.util.fileuri import scheme_data
-xenapi.VM.create({ ...
- 'PV_kernel': scheme_data.create_from_file(
- "/xen/guests/images/debian/5.0.1/vmlinuz-2.6.26-2-xen-686"),
- ... })
-\end{verbatim}
-
-Currently when using the \texttt{data} URI scheme, a temporary file is
-created on the remote dom0 in the directory
-\texttt{/var/run/xend/boot} which is then used for booting. When not
-used any longer the file is deleted. (Therefore reading of the
-\texttt{PV/kernel} or \texttt{PV/ramdisk} parameters when created with
-a \texttt{data} URI scheme returns a filename to a temporary file ---
-which might even not exists when querying.) This implementation might
-change in the way that the data is directly used --- without the
-indirection using a file. Therefore do not rely on the data resulting
-from a read of a variables which was set using the \texttt{data}
-scheme.
-
-Note: a mix of different schemes for the parameters is possible; e.g.
-the kernel can be specified with a \texttt{file} and the ramdisk with
-the \texttt{data} URI scheme.
-
\subsection{RPCs associated with class: VM}
\subsubsection{RPC name:~clone}
diff --git a/docs/xen-api/xenapi.tex b/docs/xen-api/xenapi.tex
index 68e68fae61..902d9b2daf 100644
--- a/docs/xen-api/xenapi.tex
+++ b/docs/xen-api/xenapi.tex
@@ -18,7 +18,6 @@
\usepackage{longtable}
\usepackage{fancyhdr}
\usepackage{hyperref}
-\usepackage{array}
\setlength\topskip{0cm}
\setlength\topmargin{0cm}
@@ -55,6 +54,5 @@ Xen-enabled host.
\include{vm-lifecycle}
\include{xenapi-datamodel}
\include{fdl}
-\include{bibliography}
\end{document}