From 7c03f826ebbe2340296e9b2c3acc2b2bf7a8c946 Mon Sep 17 00:00:00 2001 From: Patrick Roy Date: Wed, 3 Jul 2024 17:41:53 +0100 Subject: [PATCH] doc: fix doc comment in vsock/device.rs Correctly mark the doc comment as an inner doc comment for the enclosing macro, instead of an outer doc comment for the second import. Signed-off-by: Patrick Roy --- src/vmm/src/devices/virtio/vsock/device.rs | 29 +++++++++++----------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/src/vmm/src/devices/virtio/vsock/device.rs b/src/vmm/src/devices/virtio/vsock/device.rs index 5a99f7d7ac1..c69393c1bab 100644 --- a/src/vmm/src/devices/virtio/vsock/device.rs +++ b/src/vmm/src/devices/virtio/vsock/device.rs @@ -5,22 +5,23 @@ // Use of this source code is governed by a BSD-style license that can be // found in the THIRD-PARTY file. +//! This is the `VirtioDevice` implementation for our vsock device. It handles the virtio-level +//! device logic: feature negociation, device configuration, and device activation. +//! +//! We aim to conform to the VirtIO v1.1 spec: +//! https://docs.oasis-open.org/virtio/virtio/v1.1/virtio-v1.1.html +//! +//! The vsock device has two input parameters: a CID to identify the device, and a +//! `VsockBackend` to use for offloading vsock traffic. +//! +//! Upon its activation, the vsock device registers handlers for the following events/FDs: +//! - an RX queue FD; +//! - a TX queue FD; +//! - an event queue FD; and +//! - a backend FD. + use std::fmt::Debug; -/// This is the `VirtioDevice` implementation for our vsock device. It handles the virtio-level -/// device logic: feature negociation, device configuration, and device activation. -/// -/// We aim to conform to the VirtIO v1.1 spec: -/// https://docs.oasis-open.org/virtio/virtio/v1.1/virtio-v1.1.html -/// -/// The vsock device has two input parameters: a CID to identify the device, and a -/// `VsockBackend` to use for offloading vsock traffic. -/// -/// Upon its activation, the vsock device registers handlers for the following events/FDs: -/// - an RX queue FD; -/// - a TX queue FD; -/// - an event queue FD; and -/// - a backend FD. use log::{error, warn}; use utils::byte_order; use utils::eventfd::EventFd;