Skip to content

Commit

Permalink
doc: fix doc comment in vsock/device.rs
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
roypat committed Jul 3, 2024
1 parent 15e0c73 commit 7c03f82
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions src/vmm/src/devices/virtio/vsock/device.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit 7c03f82

Please sign in to comment.