summaryrefslogtreecommitdiff
AgeCommit message (Collapse)Author
2013-12-02tex: fix some urlsmstsirkin
replace 1.0 with v1.0 make urls work correctly in html Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@151 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-02tex: s/item:/itm:/mstsirkin
It is preferable to use standard prefixes for labels, in case we ever want to use fancyref. See http://en.wikibooks.org/wiki/LaTeX/Labels_and_Cross-referencing Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@150 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-02content.tex: fix html buildmstsirkin
_ should not be used in labels Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@149 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-02latexify document more.rusty
This change: - Turns formatted lists into real lists (itemize, etc). - Turns ascii tables into real tables. - Use \ldots for ... - Moves \footnote to immediately after what it refers to, otherwise we get awkward whitespace before the superscript. - List of stats for balloon contains values in () to match other lists. - Puts lstlisting around CCW code example - Cross references to numbered steps, rather than hardcoded (2) etc. No actual contents changed. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@148 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-02Specify requirements more clearly.rusty
The spec language is mostly written with a view to driver authors, and contains assumptions, eg: The Device Status field is updated by the OS and driver... But the spec is for both device and driver authors. It should specify exactly what is to be done, and by whom, eg: The driver MUST update the Device Status field... 1) Change from passive to active (eg "foo must be reset" => "driver must reset foo"). 2) Upcase SHOULD, MUST etc. There are probably more that I missed. 3) Make the following requirements explicit: - The driver must not clear device status bits. - Make bad on looped descriptors explicit. - Driver must not set VRING_DESC_F_INDIRECT unless negotiated feature. - Available/used ring sections rewritten to be more explicit that driver must not set VRING_AVAIL_F_NO_INTERRUPT. - Following device initialization sequence is a MUST. - Driver must not continue initialization if it sets FAILED. - "memory barriers" are now a MUST, though the weasel-word "suitable" was added. - Driver MUST notify device. 4) Misc changes: - Use "device offers" / "driver accepts" language for feature negotiation. - config space always uses little-endian, remove 'generally'. - "descriptor chain" term used everywhere. - Extraneous "+" deleted. - Remove "Unless explicitly specified otherwise" from PCI spec endian sentence. - Refer to notify_off_multiplier in queue_notify_off discussion. Signed-off-by: Rusty Russell <rusty@au.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@147 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-02pci: fix config notify bit.rusty
The Linux code uses 0x2, so I assume second lowest bit is right... Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@146 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-01tex: fix links in generated htmlmstsirkin
Use \urldef to make them expand macros. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@144 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-01title.tex: fix typo in macro usagemstsirkin
missing \ Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@143 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-01tex: tweak generated output file namesmstsirkin
Tweak output to match oasis requirements. Make it possible to specify output name through environment, and set draft stage and version automatically. Add script to export all files in a zip archive. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@142 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-01html: rename filemstsirkin
htlatex doesn't seem to support -jobname for output file name, so simply rename file before processing. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@141 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-01tex: rename filemstsirkin
Rename virtio-v1.0-csd01.tex to virtio.tex, so we don't have to rename before use. Use --jobname for output. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@140 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-12-01title.tex: add abstractmstsirkin
import from abstract.tex Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@138 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-01abstract.tex: add abstractmstsirkin
move it out of introduction.tex, use \input to avoid duplication. Fix a minor typo (the the). Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@137 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-01title.tex: comment out unused textmstsirkin
We don't have related work and xml namespaces, so comment them out. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@136 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-01title.tex: prettify slightlymstsirkin
Remove an ugly vfill, nicer to have space at bottom of page. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@135 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-01title.tex: add specification URIsmstsirkin
Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@134 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-12-01title.tex: remove list of related specificationsmstsirkin
Has a typo and it's empty anyway. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@133 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-28conformance.txt: minimal placeholdermstsirkin
We should make it clearer later, for now this should be enough for the CSD 1. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@131 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-28content.tex: split virtio-ring outmstsirkin
Split virtio_ring.h out to a separate file. Required by OASIS (though not a strict requirement for non-normative definitions like this one). Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@130 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-28title.tex: revert to standard oasis textmstsirkin
required by OASIS Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@129 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25latex: updates requested by OASIS for the CSDmstsirkin
Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@128 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25makehtml: more fedora work-aroundsmstsirkin
Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@127 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25main.tex: drop appendix stubmstsirkin
This was used to demonstrate appending format, it is no longer useful. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@126 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25makehtml: proper fix for t4htmstsirkin
So recent Fedora and some other distros have broken t4ht packages, making makehtml fail. The correct fix is to put a working t4ht somewhere in your path. For example, for Fedora one can get an old copy from here: http://pkgs.fedoraproject.org/repo/pkgs/tetex-tex4ht/tex4ht-1.0.2008_02_28_2058.tar.gz/dc9d78c8ad22acd4b40dfd2cbbe2b8de/tex4ht-1.0.2008_02_28_2058.tar.gz after unpacking, t4ht is under ./bin/linux/t4ht, put it on path. tex4ht.env is under texmf/tex4ht/base/unix/tex4ht.env, put it in $HOME (you can rename it .tex4ht) or under current directory. Revert the work-around in makehtml, but keep it around in a comment for people who want to use it. alternatively, someone might want to implement auto-detection of the broken t4ht and apply the work-around automatically. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@125 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25makehtml: import hard-coded cssmstsirkin
It should be generated from virtiohtml.cfg but this does not seem to work. For now import a hard-coded one. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@124 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25content.tex: Fix virtio-ccw cross reference.cornelia.huck
Signed-off-by: Cornelia Huck <cornelia.huck@de.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@123 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25tex: fix html build: add packagesmstsirkin
tabularx is required. Things seem to build without underscore but just in case let's import it too. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@122 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25content.tex: manual legacy pci device layoutmstsirkin
rewrite legacy pci device layout using tabularx. it was too wide for verbatim to lay out reasonably. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@121 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25content.tex: manually fix malformed tablemstsirkin
Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@120 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25content.tex: fix up cross-reference to S390mstsirkin
make it a hyper-link. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@119 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25content.tex: drop text moved to introduction.texmstsirkin
Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@118 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-25latex: add a commentmstsirkin
Add a comment about an alternative to \usepackage{underscore}, in case we'll want to use it in the future. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@116 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25latex: include content.texmstsirkin
Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@115 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25latex: add underscore packagemstsirkin
We use _ widely, make this legal so we don't need to escape all uses. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@114 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25content.tex: spec text converted to latexmstsirkin
This is simply virtio-v1.0-wd01-part1-specification.txt converted by txt2latex.pl Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@113 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25txt2latex.pl: don't put _ in labelsmstsirkin
This doesn't work well if _ is redefined, and is easy to avoid. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@112 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25txt2latex.pl: script to convert text to latexmstsirkin
The result compiles and looks kind of OK. This reverse-engineers our txt format to generate the initial latex file. Tables are included in verbatim sections. Code is included in listing sections. Math is escaped with $$. TODO (possibly manually): - remove extra sections at the beginning of the document - format tales using tabular or similar environment - format lists using itemize/enumerate/description - prevent hyphenation in the middle of identifiers Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@111 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25virtio: LaTeX: change the way the dotted lines are added in the TOCmstsirkin
Instead of using the tocloft package, which seems to collide with OASIS-style TOC headers, patch the report style. More hacky, less intrusive... Signed-off-by: Pawel Moll <pawel.moll@arm.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@110 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25virtio: LaTeX: Do not include leading numbers in the TOC linkmstsirkin
... making them black on the way. Warning! This is a hack and it depends on the hyperref package version. Signed-off-by: Pawel Moll <pawel.moll@arm.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@109 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25virtio: LaTeX: add dot lines for chapters in the TOCmstsirkin
Signed-off-by: Pawel Moll <pawel.moll@arm.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@108 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25makehtml: remove aux before generationmstsirkin
can be corrupt from previous runs. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@107 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25makepdf.sh: remove aux before generationmstsirkin
Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@106 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25makepdf: run 3 timesmstsirkin
seems to be needed to resolve cross references. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@105 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2013-11-25makehtml: use local t4ht stubmstsirkin
Fedora seems to ship a broken t4ht. Skip it. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@104 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
2013-11-25minor: fix up section cross referencesmstsirkin
Use consistent "number. name" everywhere. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@102 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-03 04:32:53 +0000