Skip to content

Commit 5d0cf8d

Browse files
committed
Add more doc aliases and doc links.
1 parent dd17708 commit 5d0cf8d

File tree

7 files changed

+88
-30
lines changed

7 files changed

+88
-30
lines changed

src/backend/libc/io/epoll.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -152,12 +152,12 @@ pub fn epoll_create(flags: CreateFlags) -> io::Result<OwnedFd> {
152152
/// `epoll_ctl(self, EPOLL_CTL_ADD, data, event)`—Adds an element to an
153153
/// `Epoll`.
154154
///
155-
/// Note that if `epoll_del` is not called on the I/O source passed into
156-
/// this function before the I/O source is `close`d, then the `epoll` will
157-
/// act as if the I/O source is still registered with it. This can lead to
158-
/// spurious events being returned from `epoll_wait`. If a file descriptor
159-
/// is an `Arc<dyn SystemResource>`, then `epoll` can be thought to maintain
160-
/// a `Weak<dyn SystemResource>` to the file descriptor.
155+
/// If `epoll_del` is not called on the I/O source passed into this function
156+
/// before the I/O source is `close`d, then the `epoll` will act as if the I/O
157+
/// source is still registered with it. This can lead to spurious events being
158+
/// returned from `epoll_wait`. If a file descriptor is an
159+
/// `Arc<dyn SystemResource>`, then `epoll` can be thought to maintain a
160+
/// `Weak<dyn SystemResource>` to the file descriptor.
161161
#[doc(alias = "epoll_ctl")]
162162
pub fn epoll_add(
163163
epoll: impl AsFd,

src/backend/linux_raw/io/epoll.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -153,12 +153,12 @@ pub fn epoll_create(flags: CreateFlags) -> io::Result<OwnedFd> {
153153
/// This registers interest in any of the events set in `events` occurring
154154
/// on the file descriptor associated with `data`.
155155
///
156-
/// Note that if `epoll_del` is not called on the I/O source passed into
157-
/// this function before the I/O source is `close`d, then the `epoll` will
158-
/// act as if the I/O source is still registered with it. This can lead to
159-
/// spurious events being returned from `epoll_wait`. If a file descriptor
160-
/// is an `Arc<dyn SystemResource>`, then `epoll` can be thought to maintain
161-
/// a `Weak<dyn SystemResource>` to the file descriptor.
156+
/// If `epoll_del` is not called on the I/O source passed into this function
157+
/// before the I/O source is `close`d, then the `epoll` will act as if the I/O
158+
/// source is still registered with it. This can lead to spurious events being
159+
/// returned from `epoll_wait`. If a file descriptor is an
160+
/// `Arc<dyn SystemResource>`, then `epoll` can be thought to maintain a
161+
/// `Weak<dyn SystemResource>` to the file descriptor.
162162
#[doc(alias = "epoll_ctl")]
163163
#[inline]
164164
pub fn epoll_add(

src/backend/linux_raw/thread/futex.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
bitflags::bitflags! {
2-
/// Flags for use with [`futex`].
2+
/// `FUTEX_*` flags for use with [`futex`].
33
///
44
/// [`futex`]: crate::thread::futex
55
pub struct FutexFlags: u32 {
@@ -10,7 +10,7 @@ bitflags::bitflags! {
1010
}
1111
}
1212

13-
/// Operations for use with [`futex`].
13+
/// `FUTEX_*` operations for use with [`futex`].
1414
///
1515
/// [`futex`]: crate::thread::futex
1616
#[derive(Debug, Copy, Clone, Eq, PartialEq)]

src/fs/raw_dir.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,7 @@ impl<'buf, Fd: AsFd> RawDir<'buf, Fd> {
139139

140140
/// A raw directory entry, similar to `std::fs::DirEntry`.
141141
///
142-
/// Note that unlike the std version, this may represent the `.` or `..`
143-
/// entries.
142+
/// Unlike the std version, this may represent the `.` or `..` entries.
144143
pub struct RawDirEntry<'a> {
145144
file_name: &'a CStr,
146145
file_type: u8,

src/process/membarrier.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ bitflags::bitflags! {
1818
/// These flags correspond to values of [`MembarrierCommand`] which are
1919
/// supported in the OS.
2020
pub struct MembarrierQuery: u32 {
21-
/// `MEMBARRIER_CMD_GLOBAL`
21+
/// `MEMBARRIER_CMD_GLOBAL` (also known as `MEMBARRIER_CMD_SHARED`)
2222
#[doc(alias = "SHARED")]
2323
#[doc(alias = "MEMBARRIER_CMD_SHARED")]
2424
const GLOBAL = MembarrierCommand::Global as _;

0 commit comments

Comments
 (0)