Skip to content

Commit c2bb2f6

Browse files
committed
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 <[email protected]>
1 parent 2b5066d commit c2bb2f6

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

src/vmm/src/devices/virtio/vsock/device.rs

+15-14
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,23 @@
55
// Use of this source code is governed by a BSD-style license that can be
66
// found in the THIRD-PARTY file.
77

8+
//! This is the `VirtioDevice` implementation for our vsock device. It handles the virtio-level
9+
//! device logic: feature negociation, device configuration, and device activation.
10+
//!
11+
//! We aim to conform to the VirtIO v1.1 spec:
12+
//! https://docs.oasis-open.org/virtio/virtio/v1.1/virtio-v1.1.html
13+
//!
14+
//! The vsock device has two input parameters: a CID to identify the device, and a
15+
//! `VsockBackend` to use for offloading vsock traffic.
16+
//!
17+
//! Upon its activation, the vsock device registers handlers for the following events/FDs:
18+
//! - an RX queue FD;
19+
//! - a TX queue FD;
20+
//! - an event queue FD; and
21+
//! - a backend FD.
22+
823
use std::fmt::Debug;
924

10-
/// This is the `VirtioDevice` implementation for our vsock device. It handles the virtio-level
11-
/// device logic: feature negociation, device configuration, and device activation.
12-
///
13-
/// We aim to conform to the VirtIO v1.1 spec:
14-
/// https://docs.oasis-open.org/virtio/virtio/v1.1/virtio-v1.1.html
15-
///
16-
/// The vsock device has two input parameters: a CID to identify the device, and a
17-
/// `VsockBackend` to use for offloading vsock traffic.
18-
///
19-
/// Upon its activation, the vsock device registers handlers for the following events/FDs:
20-
/// - an RX queue FD;
21-
/// - a TX queue FD;
22-
/// - an event queue FD; and
23-
/// - a backend FD.
2425
use log::{error, warn};
2526
use utils::byte_order;
2627
use utils::eventfd::EventFd;

0 commit comments

Comments
 (0)