Skip to content

Commit f9afef3

Browse files
authored
Update the inotify docs to remove references to the Inotify type. (#539)
Update the inotify documentation to remove references to the `Inotify` type which is no longer present in the API.
1 parent 2f58d9f commit f9afef3

File tree

3 files changed

+14
-7
lines changed

3 files changed

+14
-7
lines changed

src/backend/libc/fs/inotify.rs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ use crate::io;
77
use bitflags::bitflags;
88

99
bitflags! {
10-
/// `IN_*` for use with [`Inotify::new`].
10+
/// `IN_*` for use with [`inotify_init`].
11+
///
12+
/// [`inotify_init`]: crate::fs::inotify::inotify_init
1113
pub struct CreateFlags: c::c_int {
1214
/// `IN_CLOEXEC`
1315
const CLOEXEC = c::IN_CLOEXEC;
@@ -17,7 +19,9 @@ bitflags! {
1719
}
1820

1921
bitflags! {
20-
/// `IN*` for use with [`Inotify::add_watch`].
22+
/// `IN*` for use with [`inotify_add_watch`].
23+
///
24+
/// [`inotify_add_watch`]: crate::fs::inotify::inotify_add_watch
2125
#[derive(Default)]
2226
pub struct WatchFlags: u32 {
2327
/// `IN_ACCESS`
@@ -67,7 +71,7 @@ bitflags! {
6771
}
6872
}
6973

70-
/// `inotify_init1(flags)`—Creates a new `Inotify`.
74+
/// `inotify_init1(flags)`—Creates a new inotify object.
7175
///
7276
/// Use the [`CreateFlags::CLOEXEC`] flag to prevent the resulting file
7377
/// descriptor from being implicitly passed across `exec` boundaries.

src/backend/linux_raw/fs/inotify.rs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ use crate::io;
77
use bitflags::bitflags;
88

99
bitflags! {
10-
/// `IN_*` for use with [`Inotify::new`].
10+
/// `IN_*` for use with [`inotify_init`].
11+
///
12+
/// [`inotify_init`]: crate::fs::inotify::inotify_init
1113
pub struct CreateFlags: c::c_uint {
1214
/// `IN_CLOEXEC`
1315
const CLOEXEC = linux_raw_sys::general::IN_CLOEXEC;
@@ -17,7 +19,9 @@ bitflags! {
1719
}
1820

1921
bitflags! {
20-
/// `IN*` for use with [`Inotify::add_watch`].
22+
/// `IN*` for use with [`inotify_add_watch`].
23+
///
24+
/// [`inotify_add_watch`]: crate::fs::inotify::inotify_add_watch
2125
#[derive(Default)]
2226
pub struct WatchFlags: c::c_uint {
2327
/// `IN_ACCESS`
@@ -67,7 +71,7 @@ bitflags! {
6771
}
6872
}
6973

70-
/// `inotify_init1(flags)`—Creates a new `Inotify`.
74+
/// `inotify_init1(flags)`—Creates a new inotify object.
7175
///
7276
/// Use the [`CreateFlags::CLOEXEC`] flag to prevent the resulting file
7377
/// descriptor from being implicitly passed across `exec` boundaries.

src/io/read_write.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ pub use backend::io::io_slice::{IoSlice, IoSliceMut};
1111
#[cfg(feature = "std")]
1212
pub use std::io::{IoSlice, IoSliceMut};
1313

14-
/// `RWF_*` constants for use with [`preadv2`] and [`pwritev2`].
1514
#[cfg(any(target_os = "android", target_os = "linux"))]
1615
pub use backend::io::types::ReadWriteFlags;
1716

0 commit comments

Comments
 (0)