On Thu, Aug 04, 2022 at 12:59:14PM +0200, Ricardo Cañuelo wrote: > +References > +========== > + > +[1] Virtio Spec v1.2: > +https://docs.oasis-open.org/virtio/virtio/v1.2/virtio-v1.2.html > + > +Check for later versions of the spec as well. > + > +[2] Virtqueues and virtio ring: How the data travels > +https://www.redhat.com/en/blog/virtqueues-and-virtio-ring-how-data-travels > + > +.. rubric:: Footnotes > + > +.. [#f1] that's why they may be also referred as virtrings. Sphinx citation syntax can be used for external references, like: diff --git a/Documentation/driver-api/virtio/virtio.rst b/Documentation/driver-api/virtio/virtio.rst index 4b73c705c94c61..abd682cfd41eda 100644 --- a/Documentation/driver-api/virtio/virtio.rst +++ b/Documentation/driver-api/virtio/virtio.rst @@ -50,8 +50,8 @@ similar to the ones used in a network device: 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. -Refer to Chapter 2.5 ("Virtqueues") of the virtio spec [1] for the -reference definitions of virtqueues and to [2] for an illustrated +Refer to Chapter 2.5 ("Virtqueues") of the virtio spec [1]_ for the +reference definitions of virtqueues and to [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 @@ -138,13 +138,13 @@ calling a transport-specific ``find_vqs`` method. References ========== -[1] Virtio Spec v1.2: -https://docs.oasis-open.org/virtio/virtio/v1.2/virtio-v1.2.html +.. [1] Virtio Spec v1.2: + https://docs.oasis-open.org/virtio/virtio/v1.2/virtio-v1.2.html -Check for later versions of the spec as well. + Check for later versions of the spec as well. -[2] Virtqueues and virtio ring: How the data travels -https://www.redhat.com/en/blog/virtqueues-and-virtio-ring-how-data-travels +.. [2] Virtqueues and virtio ring: How the data travels + https://www.redhat.com/en/blog/virtqueues-and-virtio-ring-how-data-travels .. rubric:: Footnotes Otherwise the documentation LGTM (no new warnings). -- An old man doll... just what I always wanted! - Clara
Attachment:
signature.asc
Description: PGP signature
