Skip to content

Commit d81ced7

Browse files
committed
queue: small fix to QueueGuard docs
The arguments used for setting the addresses of the queue's parts should be `Some` AND valid. Signed-off-by: Laura Loghin <lauralg@amazon.com>
1 parent 8c3a5a5 commit d81ced7

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

crates/virtio-queue/src/queue_guard.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,23 +107,23 @@ where
107107
/// Set the descriptor table address for the queue.
108108
///
109109
/// The descriptor table address is 64-bit, the corresponding part will be updated if 'low'
110-
/// and/or `high` is `Some` or valid.
110+
/// and/or `high` is `Some` and valid.
111111
pub fn set_desc_table_address(&mut self, low: Option<u32>, high: Option<u32>) {
112112
self.state.set_desc_table_address(low, high);
113113
}
114114

115115
/// Set the available ring address for the queue.
116116
///
117117
/// The available ring address is 64-bit, the corresponding part will be updated if 'low'
118-
/// and/or `high` is `Some` or valid.
118+
/// and/or `high` is `Some` and valid.
119119
pub fn set_avail_ring_address(&mut self, low: Option<u32>, high: Option<u32>) {
120120
self.state.set_avail_ring_address(low, high);
121121
}
122122

123123
/// Set the used ring address for the queue.
124124
///
125125
/// The used ring address is 64-bit, the corresponding part will be updated if 'low'
126-
/// and/or `high` is `Some` or valid.
126+
/// and/or `high` is `Some` and valid.
127127
pub fn set_used_ring_address(&mut self, low: Option<u32>, high: Option<u32>) {
128128
self.state.set_used_ring_address(low, high);
129129
}

0 commit comments

Comments
 (0)