From 9cba352186b10879971630f4d68eca73c3333394 Mon Sep 17 00:00:00 2001 From: Daniel Verkamp Date: Mon, 6 Jun 2022 16:50:45 -0700 Subject: [PATCH] docs: book: link devices subpages from index Replace the source code links with the documentation pages for the devices that have them. BUG=None TEST=mdbook build docs/book TEST=Verify that devices/index.html links to the right pages Change-Id: Ie7e61adec9326466b2e1236fed4e768c2d5d3dd9 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3691975 Commit-Queue: Daniel Verkamp Tested-by: kokoro Reviewed-by: Keiichi Watanabe --- docs/book/src/devices/index.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/book/src/devices/index.md b/docs/book/src/devices/index.md index c5819cd6c5..11d8f9a6c0 100644 --- a/docs/book/src/devices/index.md +++ b/docs/book/src/devices/index.md @@ -30,8 +30,8 @@ Here is a (non-comprehensive) list of emulated devices provided by crosvm. - [`video`] - Encodes and decodes video streams. - [`wayland`] - Allows the guest to use the host's Wayland socket. - [`vsock`] - Enables use of virtual sockets for the guest. -- `vhost-user` - VirtIO devices which offloads the device implementation to another process through - the [vhost-user protocol]. +- [`vhost-user`] - VirtIO devices which offloads the device implementation to another process + through the [vhost-user protocol]. - [vmm side]: Shares its virtqueues. - [device side]: Consumes virtqueues. @@ -39,7 +39,7 @@ Here is a (non-comprehensive) list of emulated devices provided by crosvm. [vhost-user protocol]: https://qemu.readthedocs.io/en/latest/interop/vhost-user.html [vmm side]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/virtio/vhost/user/vmm/ [`balloon`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/virtio/balloon.rs -[`block`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/virtio/block/ +[`block`]: block.md [`cmos/rtc`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/cmos.rs [`console`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/virtio/console.rs [`fs`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/virtio/fs/ @@ -47,13 +47,14 @@ Here is a (non-comprehensive) list of emulated devices provided by crosvm. [`i8042`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/i8042.rs [`input`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/virtio/input/ [`iommu`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/virtio/iommu.rs -[`net`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/virtio/net.rs +[`net`]: net.md [`p9`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/virtio/p9.rs [`pmem`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/virtio/pmem.rs [`rng`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/virtio/rng.rs [`serial`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/serial.rs [`snd`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/virtio/snd/ [`tpm`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/virtio/tpm.rs +[`vhost-user`]: vhost_user.md [`video`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/virtio/video/ [`vsock`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/virtio/vhost/vsock.rs -[`wayland`]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/refs/heads/main/devices/src/virtio/wl.rs +[`wayland`]: wayland.md