From: Bagas Sanjaya <bagasdotme@gmail.com>
To: virtualization@lists.linux-foundation.org,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Cc: "Michael S. Tsirkin" <mst@redhat.com>,
"Jason Wang" <jasowang@redhat.com>,
"Jonathan Corbet" <corbet@lwn.net>,
"Ricardo Cañuelo" <ricardo.canuelo@collabora.com>,
"Cornelia Huck" <cohuck@redhat.com>,
kernel@collabora.com, "Bagas Sanjaya" <bagasdotme@gmail.com>
Subject: [PATCH 1/3] docs: driver-api: virtio: parenthesize external reference targets
Date: Tue, 20 Dec 2022 16:58:27 +0700 [thread overview]
Message-ID: <20221220095828.27588-2-bagasdotme@gmail.com> (raw)
In-Reply-To: <20221220095828.27588-1-bagasdotme@gmail.com>
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>
---
Documentation/driver-api/virtio/virtio.rst | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/Documentation/driver-api/virtio/virtio.rst b/Documentation/driver-api/virtio/virtio.rst
index 70b3aa6bcf5518..2e4ac9557f4a9f 100644
--- a/Documentation/driver-api/virtio/virtio.rst
+++ b/Documentation/driver-api/virtio/virtio.rst
@@ -11,7 +11,7 @@ Introduction
Virtio is an open standard that defines a protocol for communication
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
to interface any compliant device (real or emulated) with a driver.
@@ -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
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
-overview of how the host device and the guest driver communicate.
+Refer to Chapter 2.5 ("Virtqueues") of the virtio spec (`[1]`_) for the
+reference definitions of virtqueues and "Virtqueues and virtio ring: How
+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
ring buffers and management data. Embedded in this struct is the
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2022-12-20 10:01 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-20 9:58 [PATCH 0/3] docs: driver-api: virtio: documentation improv suggestion Bagas Sanjaya
2022-12-20 9:58 ` Bagas Sanjaya [this message]
2022-12-20 9:58 ` [PATCH 2/3] docs: driver-api: virtio: slightly reword virtqueues allocation paragraph Bagas Sanjaya
2022-12-20 9:58 ` [PATCH 3/3] docs: driver-api: virtio: commentize spec version checking Bagas Sanjaya
2022-12-20 11:11 ` [PATCH 0/3] docs: driver-api: virtio: documentation improv suggestion Michael S. Tsirkin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20221220095828.27588-2-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=cohuck@redhat.com \
--cc=corbet@lwn.net \
--cc=jasowang@redhat.com \
--cc=kernel@collabora.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mst@redhat.com \
--cc=ricardo.canuelo@collabora.com \
--cc=virtualization@lists.linux-foundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).