about summary refs log tree commit diff
path: root/library/std/src/sys
diff options
context:
space:
mode:
authorMiguel Ojeda <ojeda@kernel.org>2021-02-24 05:48:44 +0100
committerMiguel Ojeda <ojeda@kernel.org>2021-02-24 06:13:42 +0100
commiteefec8abda7cb8e8693aa876fbd1e21f2a6a5c2d (patch)
tree967ee057ebe74460adc39e7853d4ed4a9e23c47e /library/std/src/sys
parentfe1bf8e05c39bdcc73fc09e246b7209444e389bc (diff)
downloadrust-eefec8abda7cb8e8693aa876fbd1e21f2a6a5c2d.tar.gz
rust-eefec8abda7cb8e8693aa876fbd1e21f2a6a5c2d.zip
library: Normalize safety-for-unsafe-block comments
Almost all safety comments are of the form `// SAFETY:`,
so normalize the rest and fix a few of them that should
have been a `/// # Safety` section instead.

Furthermore, make `tidy` only allow the uppercase form. While
currently `tidy` only checks `core`, it is a good idea to prevent
`core` from drifting to non-uppercase comments, so that later
we can start checking `alloc` etc. too.

Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
Diffstat (limited to 'library/std/src/sys')
-rw-r--r--library/std/src/sys/windows/path.rs6
1 files changed, 4 insertions, 2 deletions
diff --git a/library/std/src/sys/windows/path.rs b/library/std/src/sys/windows/path.rs
index c10c0df4a3a..b8f512f6a23 100644
--- a/library/std/src/sys/windows/path.rs
+++ b/library/std/src/sys/windows/path.rs
@@ -8,7 +8,9 @@ mod tests;
 pub const MAIN_SEP_STR: &str = "\\";
 pub const MAIN_SEP: char = '\\';
 
-// Safety: `bytes` must be a valid wtf8 encoded slice
+/// # Safety
+///
+/// `bytes` must be a valid wtf8 encoded slice
 #[inline]
 unsafe fn bytes_as_os_str(bytes: &[u8]) -> &OsStr {
     // &OsStr is layout compatible with &Slice, which is compatible with &Wtf8,
@@ -130,7 +132,7 @@ fn parse_next_component(path: &OsStr, verbatim: bool) -> (&OsStr, &OsStr) {
             // The max `separator_end` is `bytes.len()` and `bytes[bytes.len()..]` is a valid index.
             let path = &path.bytes()[separator_end..];
 
-            // Safety: `path` is a valid wtf8 encoded slice and each of the separators ('/', '\')
+            // SAFETY: `path` is a valid wtf8 encoded slice and each of the separators ('/', '\')
             // is encoded in a single byte, therefore `bytes[separator_start]` and
             // `bytes[separator_end]` must be code point boundaries and thus
             // `bytes[..separator_start]` and `bytes[separator_end..]` are valid wtf8 slices.