jcs.org
qemu with hax to log dma reads & writes
jcs.org/2018/11/12/vfio
1@c AUTOMATICALLY GENERATED, DO NOT MODIFY
2
3@section Section
4
5@subsection Subsection
6
7@strong{strong} @emph{with emphasis}
8@code{var} @{in braces@}
9@itemize @bullet
10@item
11List item one
12@item
13Two, multiple
14lines
15
16@item
17Three
18Still in list
19
20@end itemize
21
22Not in list
23@itemize @minus
24@item
25Second list
26Note: still in list
27
28@end itemize
29
30Note: not in list
31@enumerate
32@item
33Third list
34is numbered
35
36@item
37another item
38
39@example
40example
41@end example
42
43@example
44multiple lines
45@end example
46
47
48@end enumerate
49
50Returns: the King
51Since: the first age
52Notes:
53
54@enumerate
55@item
56Lorem ipsum dolor sit amet
57
58@item
59Ut enim ad minim veniam
60
61@end enumerate
62
63Duis aute irure dolor
64
65Example:
66
67-> in
68<- out
69Examples:
70@itemize @minus
71@item
72@strong{verbatim}
73@item
74@{braces@}
75@end itemize
76
77
78
79@deftp {Enum} Enum
80
81
82
83@b{Values:}
84@table @asis
85@item @code{one}
86The @emph{one} @{and only@}
87@*@b{If:} @code{defined(IFONE)}
88@item @code{two}
89Not documented
90@end table
91
92@b{Features:}
93@table @asis
94@item @code{enum-feat}
95Also @emph{one} @{and only@}
96@end table
97@code{two} is undocumented
98
99@b{If:} @code{defined(IFCOND)}
100@end deftp
101
102
103
104@deftp {Object} Base
105
106
107
108@b{Members:}
109@table @asis
110@item @code{base1: Enum}
111the first member
112@end table
113
114@end deftp
115
116
117
118@deftp {Object} Variant1
119
120A paragraph
121
122Another paragraph (but no @code{var}: line)
123
124@b{Members:}
125@table @asis
126@item @code{var1: string}
127Not documented
128@*@b{If:} @code{defined(IFSTR)}
129@end table
130
131@b{Features:}
132@table @asis
133@item @code{variant1-feat}
134a feature
135@item @code{member-feat}
136a member feature
137@end table
138
139@end deftp
140
141
142
143@deftp {Object} Variant2
144
145
146
147@end deftp
148
149
150
151@deftp {Object} Object
152
153
154
155@b{Members:}
156@table @asis
157@item The members of @code{Base}
158@item The members of @code{Variant1} when @code{base1} is @t{"one"}
159@item The members of @code{Variant2} when @code{base1} is @t{"two"} (@b{If:} @code{IFTWO})
160@end table
161
162@b{Features:}
163@table @asis
164@item @code{union-feat1}
165a feature
166@end table
167
168@end deftp
169
170
171
172@deftp {Object} SugaredUnion
173
174
175
176@b{Members:}
177@table @asis
178@item @code{type}
179One of @t{"one"}, @t{"two"}
180@item @code{data: Variant1} when @code{type} is @t{"one"}
181@item @code{data: Variant2} when @code{type} is @t{"two"} (@b{If:} @code{IFTWO})
182@end table
183
184@b{Features:}
185@table @asis
186@item @code{union-feat2}
187a feature
188@end table
189
190@end deftp
191
192
193
194@deftp {Alternate} Alternate
195
196
197
198@b{Members:}
199@table @asis
200@item @code{i: int}
201an integer
202@code{b} is undocumented
203@item @code{b: boolean}
204Not documented
205@end table
206
207@b{Features:}
208@table @asis
209@item @code{alt-feat}
210a feature
211@end table
212
213@end deftp
214
215
216@subsection Another subsection
217
218
219@deftypefn Command {} cmd
220
221
222
223@b{Arguments:}
224@table @asis
225@item @code{arg1: int}
226the first argument
227@item @code{arg2: string} (optional)
228the second
229argument
230@item @code{arg3: boolean}
231Not documented
232@end table
233
234@b{Features:}
235@table @asis
236@item @code{cmd-feat1}
237a feature
238@item @code{cmd-feat2}
239another feature
240@end table
241
242@b{Note:}
243@code{arg3} is undocumented
244
245@b{Returns:}
246@code{Object}
247
248@b{TODO:}
249frobnicate
250
251@b{Notes:}
252@itemize @minus
253@item
254Lorem ipsum dolor sit amet
255@item
256Ut enim ad minim veniam
257
258@end itemize
259
260Duis aute irure dolor
261
262@b{Example:}
263@example
264-> in
265<- out
266@end example
267
268@b{Examples:}
269@example
270- *verbatim*
271- @{braces@}
272@end example
273
274@b{Since:}
2752.10
276
277@end deftypefn
278
279
280
281@deftypefn Command {} cmd-boxed
282
283If you're bored enough to read this, go see a video of boxed cats
284
285@b{Arguments:} the members of @code{Object}
286
287@b{Features:}
288@table @asis
289@item @code{cmd-feat1}
290a feature
291@item @code{cmd-feat2}
292another feature
293@end table
294
295@b{Example:}
296@example
297-> in
298
299<- out
300@end example
301
302@end deftypefn
303
304
305
306@deftypefn Event {} EVT-BOXED
307
308
309
310@b{Arguments:} the members of @code{Object}
311
312@b{Features:}
313@table @asis
314@item @code{feat3}
315a feature
316@end table
317
318@end deftypefn
319