Bagas Sanjaya
2b034e82ff
docs: driver-api: virtio: commentize spec version checking
...
A sentence that checks for later spec version is meant for developers
hacking the documentation source. Make it comment block (hidden from
actual output).
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com >
Message-Id: <20221220095828.27588-4-bagasdotme@gmail.com >
Signed-off-by: Michael S. Tsirkin <mst@redhat.com >
2023-02-20 19:26:57 -05:00
Bagas Sanjaya
ae8d2247af
docs: driver-api: virtio: slightly reword virtqueues allocation paragraph
...
"It's at this stage that" means "At this point", so use the latter as it
is more effective.
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com >
Message-Id: <20221220095828.27588-3-bagasdotme@gmail.com >
Signed-off-by: Michael S. Tsirkin <mst@redhat.com >
2023-02-20 19:26:56 -05:00
Bagas Sanjaya
fb25d45694
docs: driver-api: virtio: parenthesize external reference targets
...
Parenthesize targets to links in "References" section to distinguish
them from remaining texts.
While at it, describe the second target.
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com >
Message-Id: <20221220095828.27588-2-bagasdotme@gmail.com >
Signed-off-by: Michael S. Tsirkin <mst@redhat.com >
2023-02-20 19:26:56 -05:00
Ricardo Cañuelo
d16c0cd273
docs: driver-api: virtio: virtio on Linux
...
Basic doc about Virtio on Linux and a short tutorial on Virtio drivers.
includes the following fixup:
virtio: fix virtio_config_ops kerneldocs
Fixes two warning messages when building htmldocs:
warning: duplicate section name 'Note'
warning: expecting prototype for virtio_config_ops().
Prototype was for vq_callback_t() instead
Message-Id: <20221010064359.1324353-2-ricardo.canuelo@collabora.com >
Signed-off-by: Ricardo Cañuelo <ricardo.canuelo@collabora.com >
Reviewed-by: Cornelia Huck <cohuck@redhat.com >
Message-Id: <20221220100035.2712449-1-ricardo.canuelo@collabora.com >
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au >
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com >
Signed-off-by: Michael S. Tsirkin <mst@redhat.com >
2023-02-15 06:46:22 -05:00