Commit fb25d456 authored by Bagas Sanjaya's avatar Bagas Sanjaya Committed by Michael S. Tsirkin

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: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Message-Id: <20221220095828.27588-2-bagasdotme@gmail.com>
Signed-off-by: default avatarMichael S. Tsirkin <mst@redhat.com>
parent f9d9f57e
...@@ -11,7 +11,7 @@ Introduction ...@@ -11,7 +11,7 @@ Introduction
Virtio is an open standard that defines a protocol for communication Virtio is an open standard that defines a protocol for communication
between drivers and devices of different types, see Chapter 5 ("Device between drivers and devices of different types, see Chapter 5 ("Device
Types") of the virtio spec `[1]`_. Originally developed as a standard Types") of the virtio spec (`[1]`_). Originally developed as a standard
for paravirtualized devices implemented by a hypervisor, it can be used for paravirtualized devices implemented by a hypervisor, it can be used
to interface any compliant device (real or emulated) with a driver. to interface any compliant device (real or emulated) with a driver.
...@@ -43,9 +43,10 @@ similar to the ones used in a network device: ...@@ -43,9 +43,10 @@ similar to the ones used in a network device:
All the buffers the descriptors point to are allocated by the guest and All the buffers the descriptors point to are allocated by the guest and
used by the host either for reading or for writing but not for both. used by the host either for reading or for writing but not for both.
Refer to Chapter 2.5 ("Virtqueues") of the virtio spec `[1]`_ for the Refer to Chapter 2.5 ("Virtqueues") of the virtio spec (`[1]`_) for the
reference definitions of virtqueues and to `[2]`_ for an illustrated reference definitions of virtqueues and "Virtqueues and virtio ring: How
overview of how the host device and the guest driver communicate. the data travels" blog post (`[2]`_) for an illustrated overview of how
the host device and the guest driver communicate.
The :c:type:`vring_virtqueue` struct models a virtqueue, including the The :c:type:`vring_virtqueue` struct models a virtqueue, including the
ring buffers and management data. Embedded in this struct is the ring buffers and management data. Embedded in this struct is the
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment