diff options
-rw-r--r-- | .gitattributes | 1 | ||||
-rw-r--r-- | acknowledgements.tex | 10 | ||||
-rw-r--r-- | appendix-stub.tex | 6 | ||||
-rw-r--r-- | changelog.tex | 8 | ||||
-rw-r--r-- | commands-html.tex | 181 | ||||
-rw-r--r-- | commands-pdf.tex | 198 | ||||
-rw-r--r-- | commands.tex | 7 | ||||
-rw-r--r-- | conformance.tex | 6 | ||||
-rw-r--r-- | images/oasis.png | bin | 0 -> 14214 bytes | |||
-rw-r--r-- | introduction.tex | 30 | ||||
-rw-r--r-- | listings.tex | 30 | ||||
-rw-r--r-- | main.tex | 49 | ||||
-rwxr-xr-x | makehtml.sh | 15 | ||||
-rwxr-xr-x | makepdf.sh | 6 | ||||
-rw-r--r-- | specvars.tex | 17 | ||||
-rw-r--r-- | title.tex | 155 | ||||
-rw-r--r-- | virtio-v1.0-csd01-html.tex | 56 | ||||
-rw-r--r-- | virtio-v1.0-csd01.tex | 73 | ||||
-rw-r--r-- | virtiohtml.cfg | 31 |
19 files changed, 879 insertions, 0 deletions
diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..947f120 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +*.png binary diff --git a/acknowledgements.tex b/acknowledgements.tex new file mode 100644 index 0000000..3e22de2 --- /dev/null +++ b/acknowledgements.tex @@ -0,0 +1,10 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Acknowledgements +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\chapter{Acknowledgements} + +The following individuals have participated in the creation of this specification and are gratefully acknowledged: + +\begin{oasistitlesection}{Participants} + [ Participant Name, Affiliation | Individual Member ] \newline +\end{oasistitlesection} diff --git a/appendix-stub.tex b/appendix-stub.tex new file mode 100644 index 0000000..e459056 --- /dev/null +++ b/appendix-stub.tex @@ -0,0 +1,6 @@ +\chapter{Example Title} +demonstrating appendix numbering +\section{subsiduary appendix} +text +\subsection{Sub-subsiduary appendix} +text diff --git a/changelog.tex b/changelog.tex new file mode 100644 index 0000000..6f7bafd --- /dev/null +++ b/changelog.tex @@ -0,0 +1,8 @@ +\chapter{Revision History} +\begin{tabular}{ | c | c | c | p{0.4\textwidth} | } +\hline +\textbf{Revision} & \textbf{Date} & \textbf{Editor} & \textbf{Changes Made} \\ +\hline +\lbrack Rev number \rbrack & \lbrack Rev Date \rbrack & \lbrack Modified By \rbrack & \lbrack Summary of Changes \rbrack \\ +\hline +\end{tabular} diff --git a/commands-html.tex b/commands-html.tex new file mode 100644 index 0000000..ade2dd7 --- /dev/null +++ b/commands-html.tex @@ -0,0 +1,181 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% HTML specfic commands +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\newcommand{\virtiographics}[3] +{ +\HCode{<div><img src="images/#1.png" alt="#3"/></div>} +} + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% VIRTIO title sections +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\newcommand{\oasistitle}[1] +{ +\begin{spacing}{2} +\HCode{<div style="color: \#552681; font-size: 24pt;">} +\textbf{#1} +\HCode{</div>} +\end{spacing} +} + +\newcommand{\oasisstagelabel}[1] +{ +\begin{spacing}{2} +\HCode{<div style="color: \#552681; font-size: 18pt;">} +\textbf{#1} +\HCode{</div>} +\end{spacing} +} + +\newcommand{\oasisdate}[1] +{ +\begin{spacing}{2} +\HCode{<div style="color: \#552681; font-size: 18pt;">} +\textbf{#1} +\HCode{</div>} +\end{spacing} +} + +\newcommand{\oasisnoticelabel}[1] +{ +\begin{spacing}{2} +\HCode{<div style="color: \#552681; font-size: 18pt;">} +\textbf{#1} +\HCode{</div>} +\end{spacing} +} + +\newcommand{\oasisspecificationuris}[1] +{ +\HCode{<div style="color: \#552681; font-size: 12pt;">} +\textbf{#1} +\HCode{</div>} +} + +\newenvironment{oasistitlesection}[1] +{ +\HCode{<div style="color: \#552681; font-size: 10pt;">} +\textbf{#1:} +\HCode{</div>} +\HCode{<div style="margin-left: 20px;">} +} +{ +\HCode{</div>} +} + + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% VIRTIO type attributes +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +% new environment: VIRTIO type attribute +\newenvironment{virtioattribute}[2] +{ +\HCode{<div style="width: 200px; float: left;">}\texttt{\textbf{#1}}\HCode{</div>} +\HCode{<span>}#2\HCode{</span>}\\ +\begin{tabular}{p{20px}p{200px}} +&} +{\\ +\end{tabular}\\ +\vspace{0.05in} +} + +% new command: VIRTIO type attribute value +\newcommand{\virtioattributevalue}[2] +{ +\texttt{\textbf{#1}}\\ +\indent +Value: #2\\ +} + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% VIRTIO properties +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +% new environment: VIRTIO propery +\newenvironment{virtioproperty}[2] +{ +\vspace{0.05in} +\begin{tabular}{p{20px}p{200px}p{200px}} +\multicolumn{2}{p{20px}}{\textbf{\texttt{#1}}} & #2\vspace{0.05in}\\ +} +{ +\end{tabular}\\ +\vspace{0.05in}\\ +} + +% new command: VIRTIO property detail +\newcommand{\virtiopropertydetail}[2]{& #1: & #2\\} + +% new command: VIRTIO property comment +\newcommand{\virtiopropertycomment}[1]{\\&\multicolumn{2}{p{20px}}{#1}\\} + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% VIRTIO allowable actions +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +% new environment: VIRTIO allowable action +\newenvironment{virtioallowableaction}[1] +{ +\textbf{#1} +\vspace{0.05in}\\ +\begin{tabular}{p{0.1in}p{1in}p{4.8in}} +} +{ +\end{tabular}\\ +\vspace{0.05in}\\ +} + +% new command: VIRTIO allowable action detail +\newcommand{\virtioallowableactiondetail}[2]{& #1: & #2\\} + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% VIRTIO version properties +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +% new environment: VIRTIO version property +\newenvironment{virtioversionproperty}[2] +{ +\begin{tabular}{p{3in}l} +\texttt{\textbf{#1}} & #2\\ +\end{tabular}\\\ +\begin{tabular}{p{0.3in}p{5.7in}} +&} +{\\ +\end{tabular}\\ +\vspace{0.05in} +} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% VIRTIO general description +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +% new environment: VIRTIO description +\newenvironment{virtiodescription}[1] +{ +\begin{tabular}{p{20px}p{600px}} +\multicolumn{2}{l}{\textbf{#1:}}\\ +&\setlength{\topsep}{0in}\setlength{\parsep}{0in}\setlength{\partopsep}{0in} } +{\\ +\end{tabular}\\ +\vspace{0.05in} +} + + +\newenvironment{virtioexample}[1] +{ +\HCode{<div style="padding: 5px; background-color: \#E6E6E6;">} +\textbf{Example:}\\ +Request: \texttt{#1-request.log}\\ +Response: \texttt{#1-response.log} +\HCode{</div>} +\vspace{0.2in} +} + diff --git a/commands-pdf.tex b/commands-pdf.tex new file mode 100644 index 0000000..b998d4d --- /dev/null +++ b/commands-pdf.tex @@ -0,0 +1,198 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% PDF specfic commands +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\newcommand{\virtiographics}[3] +{ +\begin{figure}[htb] +\centering +\includegraphics[#2]{images/#1.pdf} +\caption{#3} +\end{figure} +\FloatBarrier +} + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% VIRTIO title sections +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\newcommand{\oasistitle}[1] +{ +\begin{spacing}{1.5} +\fontspec[Color=552681]{Arial} +\fontsize{24}{24} +\textbf{\noindent#1} +\end{spacing} +} + +\newcommand{\oasisstagelabel}[1] +{ +\begin{spacing}{1.1} +\fontspec[Color=552681]{Arial} +\fontsize{18}{18} +\textbf{\noindent#1} +\end{spacing} +} + +\newcommand{\oasisdate}[1] +{ +\begin{spacing}{1.1} +\fontspec[Color=552681]{Arial} +\fontsize{18}{18} +\textbf{\noindent#1} +\end{spacing} +} + +\newcommand{\oasisnoticelabel}[1] +{ +\begin{spacing}{1.5} +\fontspec[Color=552681]{Arial} +\fontsize{18}{18} +\textbf{\noindent#1} +\end{spacing} +} + +\newcommand{\oasisspecificationuris}[1] +{ +{ +\fontspec[Color=552681]{Arial} +\fontsize{12}{12} +\textbf{\noindent#1} +} +} + +\newenvironment{oasistitlesection}[1] +{ +\begin{tabular}{p{0.4in}p{5.8in}} +\multicolumn{2}{l}{\fontspec[Color=552681]{Arial}\fontsize{10}{10}\textbf{#1:}}\\[-0.05in] +&\setlength{\topsep}{0in}\setlength{\parsep}{0in}\setlength{\partopsep}{0in} } +{ +\end{tabular} +\vspace{-0.11in} +} + + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% VIRTIO type attributes +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +% new environment: VIRTIO type attribute +\newenvironment{virtioattribute}[2] +{ +\vspace{0.05in} +\begin{tabular}{p{2in}l} +\texttt{\textbf{#1}} & #2\\ +\end{tabular}\\\ +\begin{tabular}{p{0.3in}p{5.7in}} +&} +{\\ +\end{tabular}\\ +\vspace{0.05in} +} + +% new command: VIRTIO type attribute value +\newcommand{\virtioattributevalue}[2] +{ +\vspace{0.05in} +\noindent +\texttt{\textbf{#1}}\\ +\indent +Value: #2 +\vspace{0.05in} +} + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% VIRTIO properties +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +% new environment: VIRTIO propery +\newenvironment{virtioproperty}[2] +{ +\vspace{0.05in} +\begin{tabular}{p{0.1in}p{2.3in}p{3.5in}} +\multicolumn{2}{p{1.8in}}{\textbf{\texttt{#1}}} & #2\vspace{0.05in}\\ +} +{ +\end{tabular}\\ +\vspace{0.05in}\\ +} + +% new command: VIRTIO property detail +\newcommand{\virtiopropertydetail}[2]{& #1: & #2\\} + +% new command: VIRTIO property comment +\newcommand{\virtiopropertycomment}[1]{\\&\multicolumn{2}{p{5.7in}}{#1}\\} + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% VIRTIO allowable actions +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +% new environment: VIRTIO allowable action +\newenvironment{virtioallowableaction}[1] +{ +\vspace{0.05in} +\noindent +\textbf{#1} +\vspace{0.05in}\\ +\begin{tabular}{p{0.1in}p{1in}p{4.8in}} +} +{ +\end{tabular}\\ +\vspace{0.05in}\\ +} + +% new command: VIRTIO allowable action detail +\newcommand{\virtioallowableactiondetail}[2]{& #1: & #2\\} + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% VIRTIO version properties +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +% new environment: VIRTIO version property +\newenvironment{virtioversionproperty}[2] +{ +\vspace{0.05in} +\begin{tabular}{p{3in}l} +\texttt{\textbf{#1}} & #2\\ +\end{tabular}\\\ +\begin{tabular}{p{0.3in}p{5.7in}} +&} +{\\ +\end{tabular}\\ +\vspace{0.05in} +} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% VIRTIO general description +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +% new environment: VIRTIO description +\newenvironment{virtiodescription}[1] +{ +\vspace{0.05in} +\noindent +\begin{tabular}{p{0.1in}p{5.9in}} +\multicolumn{2}{l}{\textbf{#1:}}\\ +&\setlength{\topsep}{0in}\setlength{\parsep}{0in}\setlength{\partopsep}{0in} } +{\\ +\end{tabular}\\ +\vspace{0.05in} +} + + +\newenvironment{virtioexample}[1] +{ +\vspace{0.2in} +\begin{shaded} +\textbf{Example:}\\ +Request: \texttt{#1-request.log}\\ +Response: \texttt{#1-response.log} +\end{shaded} +\vspace{0.2in} +} + diff --git a/commands.tex b/commands.tex new file mode 100644 index 0000000..1f6fad2 --- /dev/null +++ b/commands.tex @@ -0,0 +1,7 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Commands for the VIRTIO specification document +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\definecolor{oasis1}{RGB}{85,38,129} +\definecolor{oasis2}{RGB}{227,175,27} +\definecolor{shadecolor}{RGB}{230,230,230} diff --git a/conformance.tex b/conformance.tex new file mode 100644 index 0000000..8281a1d --- /dev/null +++ b/conformance.tex @@ -0,0 +1,6 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Conformance +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\chapter{Conformance} + +The last numbered section in the specification must be the Conformance section. Conformance Statements/Clauses go here. diff --git a/images/oasis.png b/images/oasis.png Binary files differnew file mode 100644 index 0000000..e043aa1 --- /dev/null +++ b/images/oasis.png diff --git a/introduction.tex b/introduction.tex new file mode 100644 index 0000000..0047af4 --- /dev/null +++ b/introduction.tex @@ -0,0 +1,30 @@ +\chapter{Introduction} + +\section{Terminology} + +The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in \hyperref[intro:rfc2119]{[RFC2119]}. + + +\section{Normative References} + +\begin{longtable}{l p{5in}} + \phantomsection\label{intro:rfc2119}\textbf{[RFC2119]} & S. Bradner, Key words for use in RFCs to Indicate Requirement Levels, \newline\url{http://www.ietf.org/rfc/rfc2119.txt}, March 1997\\ +\end{longtable} + + +\section{Non-Normative References} + + + + + +\newpage +\section{Section} + + +\subsection{Second level heading} +\subsubsection{Third level heading} +\paragraph{Fourth level heading} +\subparagraph{Fifth level heading} + + diff --git a/listings.tex b/listings.tex new file mode 100644 index 0000000..9b88b77 --- /dev/null +++ b/listings.tex @@ -0,0 +1,30 @@ +% listings setup +\definecolor{LISTING_background}{RGB}{245,245,245} +\lstset{ + basicstyle=\footnotesize\ttfamily, + extendedchars=true, + backgroundcolor=\color{LISTING_background}, + showspaces=false, + showstringspaces=false, + showtabs=false, + frame=single, + tabsize=2, + breaklines=true, + breakatwhitespace=true, + postbreak=\raisebox{0ex}[0ex][0ex]{\ensuremath{\hookrightarrow\space}} +} + +\definecolor{XML_string}{RGB}{0,0,0} +\definecolor{XML_identifier}{RGB}{0,0,128} +\definecolor{XML_keyword}{RGB}{200,0,0} +\lstdefinelanguage{XML} +{ + morestring=[b]", + morestring=[s]{>}{<}, + morecomment=[s]{<?}{?>}, + stringstyle=\color{XML_string}, + identifierstyle=\color{XML_identifier}, + keywordstyle=\color{XML_keyword}, + morekeywords={virtio} +} + diff --git a/main.tex b/main.tex new file mode 100644 index 0000000..38c451e --- /dev/null +++ b/main.tex @@ -0,0 +1,49 @@ +% section numbers 5 levels deep +\setcounter{secnumdepth}{5} + +\begin{document} +\pagestyle{fancy} + +% start text +\setcounter{page}{1} + +%%% define header and footer +\virtioheaderfooter + +%%% define header an footer for chapter title pages +\fancypagestyle{plain}{\fancyhf{}\virtioheaderfooter} + +% title page +\input{title.tex} + +% ToC +\setcounter{page}{4} +\setcounter{tocdepth}{4} +\renewcommand{\contentsname}{Table of Contents} +\addtocontents{toc}{\protect\virtioheaderfooter} +\tableofcontents +\newpage + +%%% line numbers? +%\linenumbers + +% introduction +\input{introduction.tex} + +% Conformance +\input{conformance.tex} + +% appendix +\appendix +\def\@chapapp{\appendixname} + +% acknowledgements +\input{acknowledgements.tex} + +%appendix stub +\input{appendix-stub.tex} + +% draft change log +\input{changelog.tex} + +\end{document} diff --git a/makehtml.sh b/makehtml.sh new file mode 100755 index 0000000..000a5bc --- /dev/null +++ b/makehtml.sh @@ -0,0 +1,15 @@ +#!/bin/sh + +SPECDOC=virtio-v1.0-csd01-html + +htlatex $SPECDOC.tex "virtiohtml,info,charset=utf-8" " -cunihtf -utf8" + +mv $SPECDOC.html $SPECDOC.tmp1 + +sed 's/~~/"/g' $SPECDOC.tmp1 >$SPECDOC.tmp2 +sed 's/>~/>"/g' $SPECDOC.tmp2 >$SPECDOC.tmp3 +sed 's/>=~/>="/g' $SPECDOC.tmp3 >$SPECDOC.tmp4 +sed 's/~</"</g' $SPECDOC.tmp4 >$SPECDOC.tmp5 + +mv $SPECDOC.tmp5 $SPECDOC.html +rm $SPECDOC.tmp* diff --git a/makepdf.sh b/makepdf.sh new file mode 100755 index 0000000..88aafe3 --- /dev/null +++ b/makepdf.sh @@ -0,0 +1,6 @@ +#!/bin/sh + +SPECDOC=virtio-v1.0-csd01 + +xelatex $SPECDOC.tex +xelatex $SPECDOC.tex diff --git a/specvars.tex b/specvars.tex new file mode 100644 index 0000000..0b462f1 --- /dev/null +++ b/specvars.tex @@ -0,0 +1,17 @@ +% define VIRTIO Working Draft number and date +\newcommand{\virtioversion}{Virtual I/O Device (VIRTIO) Version 1.0} +\newcommand{\virtioworkingdraft}{01} +\newcommand{\virtioworkingdraftdate}{05 Nov 2013} +\newcommand{\virtiospecfile}{virtio-v1.0-wd01} +\newcommand{\virtioworkproduct}{Standards Track Draft} +\newcommand{\virtiooasiscopyright}{Copyright © OASIS Open 2013. All Rights Reserved.} + +% PDF setup +\hypersetup{ +pdfauthor = {OASIS Virtual I/O Device (VIRTIO) TC}, +pdftitle = {Virtual I/O Device (VIRTIO) Version 1.0}, +pdfsubject = {Virtual I/O Device (VIRTIO) Version 1.0}, +pdfkeywords = {VIRTIO, Virtual I/O Device}, +colorlinks = {true}, +linkcolor=blue, +urlcolor = blue} diff --git a/title.tex b/title.tex new file mode 100644 index 0000000..8cd8f68 --- /dev/null +++ b/title.tex @@ -0,0 +1,155 @@ +\begin{titlepage} +\thispagestyle{fancy} + +\begin{tabular*}{\textwidth}{@{\extracolsep{\fill}}lr} + \includegraphics[height=0.55in]{images/oasis.png}\\ + \hline +\end{tabular*} + +\oasistitle{Virtual I/O Device (VIRTIO) Version 1.0} +\oasisstagelabel{Working Draft} +\vspace{0.05in}\vfill +\oasisstagelabel{\virtioworkingdraftdate} + +\vfill + +\begin{oasistitlesection}{Technical Committee} +\href{https://www.oasis-open.org/committees/virtio/}{OASIS Virtual I/O Device (VIRTIO) TC} +\end{oasistitlesection} + +\begin{oasistitlesection}{Chair} +Rusty Russell (\href{mailto:rusty@au.ibm.com}{rusty@au.ibm.com}), \href{http://www.ibm.com/}{IBM}\newline +\end{oasistitlesection} + +\begin{oasistitlesection}{Editors} +Michael S. Tsirkin (\href{mailto:mst@redhat.com}{mst@redhat.com}), \href{http://redhat.com/}{Red Hat}\newline +Cornelia Huck (\href{mailto:cornelia.huck@de.ibm.com}{cornelia.huck@de.ibm.com}), \href{http://www.ibm.com/}{IBM}\newline +Pawel Moll (\href{mailto:pawel.moll@arm.com}{pawel.moll@arm.com}), \href{https://arm.com/}{ARM Limited} +\end{oasistitlesection} + + +\begin{oasistitlesection}{Additional artifacts} +This prose specification is one component of a Work Product which also includes: +\begin{itemize*} + \item XML schemas (list)\newline + \item TeX source files for this prose document:\newline + \url{http://docs.oasis-open.org/virtio/virtio/v1.0/csd01/tex/} +\end{itemize*} +\end{oasistitlesection} +\vspace{-0.2in} + +\begin{oasistitlesection}{Related work} +This specification replaces or supersedes: +\begin{itemize*} + \item Virtio PCI Card Specification Version 0.9.5:\newline + \url{http://ozlabs.org/~rusty/virtio-spec/virtio-0.9.5.pdf} +\end{itemize*} +This specification is related to: +\begin{itemize*} + \item Related speifications (list) +\end{itemize*} +\end{oasistitlesection} +\vspace{-0.2in} + +\begin{oasistitlesection}{Declared XML namespaces} +\vspace{-0.1in} +\begin{itemize*} + \item namespaces which are declared, not just referenced or used (list) +\end{itemize*} +\end{oasistitlesection} + +\begin{oasistitlesection}{Abstract} +Summary of the technical purpose of the specification +\end{oasistitlesection} + +\begin{oasistitlesection}{Status} +This \href{https://www.oasis-open.org/committees/process.php#dWorkingDraft}{Working Draft} (WD) has been produced by one or more TC Members; it has not yet been voted on by the TC or \href{https://www.oasis-open.org/committees/process.php#committeeDraft}{approved} as a Committee Draft (Committee Specification Draft or a Committee Note Draft). The OASIS document \href{https://www.oasis-open.org/committees/process.php#standApprovProcess}{Approval Process} begins officially with a TC vote to approve a WD as a Committee Draft. A TC may approve a Working Draft, revise it, and re-approve it any number of times as a Committee Draft. + +Technical Committee members should send comments on this specification to the Technical Committee’s \href{https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=virtio#feedback}{mailing list}. Others should send comments to the Technical Committee by sending mail to the virtio-comment public mailing list or using the "\href{https://www.oasis-open.org/committees/comments/form.php?wg_abbrev=virtio}{Send A Comment}" button on the Technical Committee’s web page at \url{https://www.oasis-open.org/committees/virtio/}. +\end{oasistitlesection} + + +\oasisspecificationuris{Initial URI pattern}\newline +\url{http://docs.oasis-open.org/virtio/virtio/v1.0/csd01/virtio-v1.0-csd01.odt}\newline +(Managed by OASIS TC Administration; please don’t modify.)\newline +\url{http://docs.oasis-open.org/virtio/virtio/v1.0/csd01/virtio-v1.0-csd01.pdf} (Authoritative)\newline +\url{http://docs.oasis-open.org/virtio/virtio/v1.0/csd01/virtio-v1.0-csd01.html} + +\vfill\newpage + + +\vfill\newpage + +\oasisnoticelabel{Notices} + +Copyright © OASIS Open 2013. All Rights Reserved. + +All capitalized terms in the following text have the meanings assigned +to them in the OASIS Intellectual Property Rights Policy (the "OASIS +IPR Policy"). The full \href{https://www.oasis-open.org/policies-guidelines/ipr}{Policy} may be found at the OASIS website. + +This document and translations of it may be copied and furnished to +others, and derivative works that comment on or otherwise explain it +or assist in its implementation may be prepared, copied, published, +and distributed, in whole or in part, without restriction of any kind, +provided that the above copyright notice and this section are included +on all such copies and derivative works. However, this document itself +may not be modified in any way, including by removing the copyright +notice or references to OASIS, except as needed for the purpose of +developing any document or deliverable produced by an OASIS Technical +Committee (in which case the rules applicable to copyrights, as set +forth in the OASIS IPR Policy, must be followed) or as required to +translate it into languages other than English. + +The limited permissions granted above are perpetual and will not be +revoked by OASIS or its successors or assigns. + +This document and the information contained herein is provided on an +"AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, +INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE +INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY +IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR +PURPOSE. + +OASIS requests that any OASIS Party or any other party that believes +it has patent claims that would necessarily be infringed by +implementations of this OASIS Committee Specification or OASIS +Standard, to notify OASIS TC Administrator and provide an indication +of its willingness to grant patent licenses to such patent claims in a +manner consistent with the IPR Mode of the OASIS Technical Committee +that produced this specification. + +OASIS invites any party to contact the OASIS TC Administrator if it is +aware of a claim of ownership of any patent claims that would +necessarily be infringed by implementations of this specification by a +patent holder that is not willing to provide a license to such patent +claims in a manner consistent with the IPR Mode of the OASIS Technical +Committee that produced this specification. OASIS may include such +claims on its website, but disclaims any obligation to do so. + +OASIS takes no position regarding the validity or scope of any +intellectual property or other rights that might be claimed to pertain +to the implementation or use of the technology described in this +document or the extent to which any license under such rights might or +might not be available; neither does it represent that it has made any +effort to identify any such rights. Information on OASIS' procedures +with respect to rights in any document or deliverable produced by an +OASIS Technical Committee can be found on the OASIS website. Copies of +claims of rights made available for publication and any assurances of +licenses to be made available, or the result of an attempt made to +obtain a general license or permission for the use of such proprietary +rights by implementers or users of this OASIS Committee Specification +or OASIS Standard, can be obtained from the OASIS TC Administrator. +OASIS makes no representation that any information or list of +intellectual property rights will at any time be complete, or that any +claims in such list are, in fact, Essential Claims. + +The name "OASIS" is a trademark of \href{https://www.oasis-open.org/}{OASIS}, the owner and developer of +this specification, and should be used only to refer to the +organization and its official outputs. OASIS welcomes reference to, +and implementation and use of, specifications, while reserving the +right to enforce its marks against misleading uses. Please see +\url{https://www.oasis-open.org/policies-guidelines/trademark} for above guidance. +\\\\ + +\end{titlepage} diff --git a/virtio-v1.0-csd01-html.tex b/virtio-v1.0-csd01-html.tex new file mode 100644 index 0000000..038ea09 --- /dev/null +++ b/virtio-v1.0-csd01-html.tex @@ -0,0 +1,56 @@ +%!TEX encoding = UTF-8 Unicode +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% VIRTIO 1.0 Specification Draft +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\documentclass[10pt,titlepage]{report} + +\usepackage{parskip} +\usepackage{setspace} +\usepackage[english]{babel} +\usepackage{ae,aecompl} +\usepackage[T1]{fontenc} +\usepackage{graphicx} +\usepackage{framed} +\usepackage{hyperref} +\usepackage{lineno} +\usepackage{listings} +\usepackage{courier} +\usepackage{fancyvrb} +\usepackage{array} +\usepackage{longtable} +\usepackage{multirow} +\usepackage{rotating} +\usepackage{fancyhdr} +\usepackage{lastpage} +\usepackage{todonotes} +\usepackage{titlesec} +\usepackage{mdwlist} +\usepackage{url} +\usepackage{xifthen} + +\usepackage[utf8x]{inputenc} + +\urlstyle{rm} + +% commands +\input{specvars.tex} +\input{commands.tex} +\input{commands-html.tex} +\input{listings.tex} + +% new command: header and footer +\newcommand{\virtioheaderfooter}{} + +% headers setup +\titleformat{\chapter}[block]{\titlerule\normalfont\huge\bfseries}{\thechapter}{0pt}{} +\titleformat{\section}{\normalfont\Large\bfseries}{\thesection}{1em}{} +\titleformat{\subsection}{\normalfont\large\bfseries}{\thesubsection}{1em}{} +\titleformat{\subsubsection}{\normalfont\normalsize\bfseries}{\thesubsubsection}{1em}{} +\titleformat{\paragraph}[hang]{\normalfont\normalsize\bfseries}{\theparagraph}{1em}{} +\titleformat{\subparagraph}[hang]{\normalfont\normalsize\bfseries}{\thesubparagraph}{1em}{} + + + +% main document +\input{main.tex} diff --git a/virtio-v1.0-csd01.tex b/virtio-v1.0-csd01.tex new file mode 100644 index 0000000..3b1546f --- /dev/null +++ b/virtio-v1.0-csd01.tex @@ -0,0 +1,73 @@ +%!TEX TS-program = xelatex +%!TEX encoding = UTF-8 Unicode +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% VIRTIO 1.0 Specification Draft +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\documentclass[10pt,titlepage]{report} + +\usepackage[top=1in,left=1in,bottom=0.5in,right=1in,paperwidth=8.5in, paperheight=11in]{geometry} +\usepackage{parskip} +\usepackage{setspace} +\usepackage[english]{babel} +\usepackage{ae,aecompl} +\usepackage[T1]{fontenc} +\usepackage[xetex]{graphicx} +\usepackage{placeins} +\usepackage{framed} +\usepackage[xetex]{hyperref} +\usepackage{lineno} +\usepackage{listings} +\usepackage{courier} +\usepackage{fancyvrb} +\usepackage{array} +\usepackage{longtable} +\usepackage{multirow} +\usepackage{rotating} +\usepackage{fancyhdr} +\usepackage{lastpage} +\usepackage{todonotes} +\usepackage[explicit]{titlesec} +\usepackage{mdwlist} +\usepackage{url} +\usepackage{xifthen} +\usepackage[no-math]{fontspec} +\usepackage{xltxtra} +\setmainfont[Mapping=tex-text]{Arial} +\setromanfont{Arial} +\setmonofont{Courier New} + +\urlstyle{rm} + +% commands +\input{specvars.tex} +\input{commands.tex} +\input{commands-pdf.tex} +\input{listings.tex} + +% new command: header and footer +\newcommand{\virtioheaderfooter}{ +\pagestyle{fancy} +\fancyhf{} +\renewcommand{\headrulewidth}{0pt} +\renewcommand{\footrulewidth}{0pt} +\fancyfoot[L]{\footnotesize\virtiospecfile\\\virtioworkproduct} +\fancyfoot[C]{\footnotesize\ \\\virtiooasiscopyright} +\fancyfoot[R]{\footnotesize\virtioworkingdraftdate\\Page \thepage\ of \pageref*{LastPage}} +} + +% page setup +\setlength{\headheight}{0pt} +\setlength{\headsep}{10pt} +\setlength{\extrarowheight}{0.05in} + +% headers setup +\titleformat{\chapter}[block]{\titlerule}{}{0pt}{\color{oasis1}\fontsize{18}{18}\textbf{\ifthenelse{\equal{\@chapapp}{\appendixname}}{Appendix~\thechapter.\ #1}{\ifthenelse{\equal{\thechapter}{0}}{}{\thechapter\ \ }#1}}\vspace{-0.3in}} +\titleformat{\section}{\color{oasis1}\normalfont\Large\bfseries}{\color{oasis1}\thesection}{1em}{#1} +\titleformat{\subsection}{\color{oasis1}\normalfont\large\bfseries}{\color{oasis1}\thesubsection}{1em}{#1} +\titleformat{\subsubsection}{\color{oasis1}\normalfont\normalsize\bfseries}{\color{oasis1}\thesubsubsection}{1em}{#1} +\titleformat{\paragraph}[hang]{\color{oasis1}\normalfont\normalsize\bfseries}{\color{oasis1}\theparagraph}{1em}{#1} +\titleformat{\subparagraph}[hang]{\color{oasis1}\normalfont\normalsize\bfseries}{\color{oasis1}\thesubparagraph}{1em}{#1} + +% main document +\input{main.tex} diff --git a/virtiohtml.cfg b/virtiohtml.cfg new file mode 100644 index 0000000..0106271 --- /dev/null +++ b/virtiohtml.cfg @@ -0,0 +1,31 @@ +\Preamble{html} +\begin{document} + \ConfigureMark{chapter}{\HCode{<hr><span class="titlemark">}\thechapter\HCode{</span>}} + \ConfigureMark{paragraph}{\HCode{<span class="titlemark">}\theparagraph\HCode{</span>}} + \ConfigureMark{subparagraph}{\HCode{<span class="titlemark">}\thesubparagraph\HCode{</span>}} + + \Configure{chapter}{}{}{\ShowPar\IgnoreIndent\HCode{<h2 class="chapterHead">}\begingroup\TitleMark\space}{\endgroup\HCode{</h2>}\par\IgnorePar} + \Configure{paragraph}{}{}{\ShowPar\IgnoreIndent\HCode{<h5 class="paragraphHead">}\begingroup\TitleMark\space}{\endgroup\HCode{</h5>}\par\IgnorePar} + \Configure{subparagraph}{}{}{\ShowPar\IgnoreIndent\HCode{<h6 class="subparagraphHead">}\begingroup\TitleMark\space}{\endgroup\HCode{</h6>}\par\IgnorePar} + \Configure{appendix}{}{}{\ShowPar\IgnoreIndent\HCode{<h2 class="appendixHead">}\begingroup\TitleMark.\space}{\endgroup\HCode{</h2>}\par\IgnorePar} + + \Configure{tabular} + {\HCode{<table>}}{\HCode{</table>}} + {\HCode{<tr class="row-\HRow">}}{\HCode{</tr>}} + {\HCode{<td style="text-align: left; min-width: \HColWidth" \ifnum \HMultispan>1 colspan="\HMultispan"\fi >}}{\HCode{</td>}} + + + %%\Configure{HColWidth}{\HCode{ style="min-width:\HColWidth"}} + + \Configure{@TITLE}{Virtual I/O Device (VIRTIO) Version 1.0} + \Css{body { font-family: Arial, Helvetica, sans-serif; font-size: 10pt; }} + \Css{h1 { color:\#552681; font-size:150\%; }} + \Css{h2 { color:\#552681; font-size:140\%; }} + \Css{h3 { color:\#552681; font-size:130\%; }} + \Css{h4 { color:\#552681; font-size:120\%; }} + \Css{h5 { color:\#552681; font-size:110\%; }} + \Css{h6 { color:\#552681; font-size:100\%; }} + \Css{table.tabular { margin-left: 0em; }} + \Css{dt { margin-top: 0.5em; }} + \Css{div.lstlisting, div.lstinputlisting {font-family: Courier New, monospace; white-space: nowrap; margin-top:0.5em; margin-bottom:0.5em; padding: 5px; border: 1px solid black; color: black; background-color: \#F5F5F5;}} +\EndPreamble |