Skip to content

Commit 188ce1d

Browse files
committed
chore: fix doc comment indentation
The paragraph refers to the two items in the previous numbered list, so it must not be indented. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
1 parent 3104fe6 commit 188ce1d

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

src/volatile_memory.rs

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,15 @@
1616
//! doing with that hunk of memory.
1717
//!
1818
//! For the purposes of maintaining safety, volatile memory has some rules of its own:
19+
//!
1920
//! 1. No references or slices to volatile memory (`&` or `&mut`).
21+
//!
2022
//! 2. Access should always been done with a volatile read or write.
21-
//! The First rule is because having references of any kind to memory considered volatile would
22-
//! violate pointer aliasing. The second is because unvolatile accesses are inherently undefined if
23-
//! done concurrently without synchronization. With volatile access we know that the compiler has
24-
//! not reordered or elided the access.
23+
//!
24+
//! The First rule is because having references of any kind to memory considered volatile would
25+
//! violate pointer aliasing. The second is because unvolatile accesses are inherently undefined if
26+
//! done concurrently without synchronization. With volatile access we know that the compiler has
27+
//! not reordered or elided the access.
2528
2629
use std::cmp::min;
2730
use std::io::{self, Read, Write};

0 commit comments

Comments
 (0)