summaryrefslogtreecommitdiff
path: root/introduction.tex
AgeCommit message (Collapse)Author
2018-03-20introduction: document bitfield notationMichael S. Tsirkin
Bitfields are a useful and familiar way to specify sub-byte structure layout. The only issue is that bitfield order isn't portable across architectures. Document that we list bitfields from least to most significant one, and warn about portability issues. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Approved-by: https://www.oasis-open.org/apps/org/workgroup/virtio/ballot.php?id=3177 Fixes: https://github.com/oasis-tcs/virtio-spec/issues/3
2015-10-21cl: document resolution for VIRTIO-146.mstsirkin
add advice on transition from earlier drafts. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@551 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2015-10-21intro: add advice on transition from legacy interfacesmstsirkin
Reading legacy chapters gives a hint about what changed, let's help readers discover this useful shortcut. This resolves VIRTIO-146. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Reviewed-by: Cornelia Huck <cornelia.huck@de.ibm.com> Accepted by electronic ballot: https://www.oasis-open.org/apps/org/workgroup/virtio/ballot.php?id=2866 git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@548 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-13VIRTIO-60: avoid vring and VIRTIO_RING.rusty
These are never introduced, so use simpler names: virtq* for structures and VIRTIO_ for features. I added two notes about the old names, for helping people coming from the old spec. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@327 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-13VIRTIO-74: required vs REQUIRED.rusty
Some really are clearest as they are, but most are changed to avoid confusion. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@319 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-03Formatting: use latex-style quoting everywhere.rusty
Doesn't look any different, but consistent. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@310 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02fix rfc2119 referencemstsirkin
Change accepted on VIRTIO TC Meeting, 3 December 2013 VIRTIO-68 Cc: Patrick Durusau <patrick@durusau.net> Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@306 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02legacy interface: move to terminologymstsirkin
Change accepted on VIRTIO TC Meeting, 3 December 2013 VIRTIO-64 Cc: Patrick Durusau <patrick@durusau.net Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@303 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02introduction: add link to 0.9.5 specificationmstsirkin
Change accepted on VIRTIO TC Meeting, 3 December 2013 this version replaces it, so it's a non normative reference. VIRTIO-69 note: the link is added here but isn't used yet: will be used when we cleanup terminology definitions, by addressing VIRTIO-64 Cc: Patrick Durusau <patrick@durusau.net Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@302 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26introduction: typo in terminology sectioncornelia.huck
s/device/driver/ for the transitional driver description. Signed-off-by: Cornelia Huck <cornelia.huck@de.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@282 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: SCSI: Separate normative and descriptive texts.rusty
This could use some more rigour, I think: there are still many implied requirements which could be called out. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@276 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: net: separate normative and instructional text.rusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@273 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: move legacy/transitional definitions into terminology.rusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@263 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: add old draft to normative references (VIRTIO-77)rusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@261 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: use proper list in introduction (VIRTIO-82)rusty
Also avoid extra spacing before footnote markers. Reported-by: Patrick Durusau <patrick@durusau.net> Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@260 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-12introduction: address lnovich commentsmstsirkin
generally list of buses is out of date, list all supported buses. Drop explicit mention of lguest since it's not part of the spec. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@246 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-12Fix S390 normative references.rusty
As pointed out in TAB-539 and TAB-540: - Add an URL to the documents. (Unfortunately, there is no link that always points to the latest version.) - State that we include any future revisions as well. As per minutes: https://lists.oasis-open.org/archives/virtio/201402/msg00121.html Signed-off-by: Cornelia Huck <cornelia.huck@de.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@243 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-12Feedback #8: Applied.rusty
[ Includes fixup! removing MSI-X ] As per minutes: https://lists.oasis-open.org/archives/virtio/201402/msg00121.html Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@239 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-12Feedback #5: Applied.rusty
As per minutes: https://lists.oasis-open.org/archives/virtio/201402/msg00121.html Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@236 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-12C struct specifications.rusty
Explicitly specify that our C struct specifications are without padding, and add some definitions for our integer data types. [ Rusty - added /* comments */ and removed redundant old le* explanation ] Signed-off-by: Cornelia Huck <cornelia.huck@de.ibm.com> Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@231 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-10REVERT LAST 15 JUNK COMMITS.rusty
Back to r211. It's been a long day. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@225 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-10We'll add more non-normative sections with hints forrusty
implementing registers such as PCI class, status and command registers. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@219 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-10patch feedback-5.patchrusty
git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@215 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-10C struct specifications.rusty
Explicitly specify that our C struct specifications are without padding, and add some definitions for our integer data types. [ Rusty - added /* comments */ and removed redundant old le* explanation ] Signed-off-by: Cornelia Huck <cornelia.huck@de.ibm.com> Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@212 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-121. Introduction: Removed left-over "PCI"hornet
The "Extensible" paragraph of the introduction still referred to "Virtio PCI devices". Changed to "Virtio devices". Signed-off-by: Pawel Moll <pawel.moll@arm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@175 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-03Formatting repair as per Chet's feedback.rusty
1) Populate TC member list. 2) Remove Non-Normative References section 3) Fix URLs to point to correct place. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@153 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-02Terminology: Device and driver, not host and guest.rusty
We've mixed both together, whereas from a spec-reader point of view, "driver" and "device" is probably clearer. CCW part incorporated: Switch the parts of the virtio-ccw specification that did not already to device/driver instead of guest/host. For more general discussions, host/guest is kept (like when talking about guest<->host notifications in general). This should make things more consistent. Signed-off-by: Cornelia Huck <cornelia.huck@de.ibm.com> Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@145 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-01introduction.tex: import abstractmstsirkin
import abstract from abstract.tex Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@139 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-28introduction.tex: make keywords upper-casemstsirkin
This seems to be the consensus. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@132 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25introduction.tex: import from text documentmstsirkin
manually import introduction from main text. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@117 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25virtio: add latex templates from CMISmstsirkin
I imported latex templates from the CMIS specifications and changed s/CMIS/VIRTIO/ everywhere. The result is very close to one produced by exporting from the ODF we were supplied, with the exception of the TOC formatting, where section numbers are in blue instead of black, and major sections don't have dots leading to page numbers. I'm guessing this isn't very important, someone with more latex knowledge can try to figure this out. Generating html doesn't actually work for me. It doesn't work for me for CMIS either, so it's probably just an issue with my local latex setup. I'm not sure we need html output at all. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@103 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-19 15:58:49 +0000