Skip to content

Commit

Permalink
Refer to macOS by that name rather than OS X.
Browse files Browse the repository at this point in the history
  • Loading branch information
waywardmonkeys authored and passcod committed Apr 7, 2018
1 parent 3ea9c48 commit 9bbe322
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 18 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Crate download count](https://img.shields.io/crates/d/notify.svg?style=flat-square)][crate]

[![Appveyor](https://img.shields.io/appveyor/ci/passcod/rsnotify.svg?style=flat-square)][build-windows] <sup>(Windows)</sup>
[![Travis](https://img.shields.io/travis/passcod/notify.svg?style=flat-square)][build-unix] <sup>(Linux and OS X)</sup>
[![Travis](https://img.shields.io/travis/passcod/notify.svg?style=flat-square)][build-unix] <sup>(Linux and macOS)</sup>

[![Code of Conduct](https://img.shields.io/badge/contributor-covenant-123456.svg?style=flat-square)][coc]
[![Documentation](https://img.shields.io/badge/documentation-docs.rs-df3600.svg?style=flat-square)][docs]
Expand Down Expand Up @@ -98,7 +98,7 @@ To upgrade to Notify 3+ with minimal behaviour change:
## Platforms

- Linux / Android: inotify
- OS X: FSEvents
- macOS: FSEvents
- Windows: ReadDirectoryChangesW
- All platforms: polling

Expand All @@ -111,7 +111,7 @@ with a slight performance cost.

## Todo

- BSD / OS X / iOS: kqueue
- BSD / macOS / iOS: kqueue
- Solaris 11: FEN

Pull requests and bug reports happily accepted!
Expand Down
2 changes: 1 addition & 1 deletion clippy.toml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
doc-valid-idents = ["GitHub", "FSEvents", "ReadDirectoryChangesW", "FileSystemEventSecurity", "iOS"]
doc-valid-idents = ["GitHub", "FSEvents", "ReadDirectoryChangesW", "FileSystemEventSecurity", "iOS", "macOS"]
20 changes: 10 additions & 10 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@ mod debounce;
///
/// # Chmod
///
/// __Linux, OS X__
/// __Linux, macOS__
///
/// On Linux and OS X the `CHMOD` event is emitted whenever attributes or extended attributes
/// On Linux and macOS the `CHMOD` event is emitted whenever attributes or extended attributes
/// change.
///
/// __Windows__
Expand Down Expand Up @@ -194,9 +194,9 @@ mod debounce;
/// When watching a directory on Windows, the watch will get destroyed and no new events will be
/// sent.
///
/// __OS X__
/// __macOS__
///
/// While Linux and Windows monitor "inodes", OS X monitors "paths". So a watch stays active even
/// While Linux and Windows monitor "inodes", macOS monitors "paths". So a watch stays active even
/// after the watched file or directory has been removed and it will emit events in case a new file
/// or directory is created in its place.
///
Expand All @@ -220,7 +220,7 @@ mod debounce;
/// A rename that originates outside of a watched directory and ends inside of a watched directory
/// produces a `CREATE` event.
///
/// __OS X__
/// __macOS__
///
/// A `RENAME` event is produced whenever a file or directory is moved. This includes moves within
/// the watched directory as well as moves into or out of the watched directory. It is up to the
Expand Down Expand Up @@ -252,9 +252,9 @@ mod debounce;
/// When renaming a watched file, a `RENAME` event is emitted but the old path will continue to be
/// watched.
///
/// __OS X__
/// __macOS__
///
/// OS X will continue to watch the (now non-existing) path.
/// macOS will continue to watch the (now non-existing) path.
///
/// ## Rename parent directory of watched file or directory
///
Expand All @@ -268,9 +268,9 @@ mod debounce;
/// Linux and Windows will continue to watch the moved file or directory. Events will contain paths
/// prefixed with the old path.
///
/// __OS X__
/// __macOS__
///
/// OS X will continue to watch the (now non-existing) path.
/// macOS will continue to watch the (now non-existing) path.
///
///
/// # Rescan
Expand Down Expand Up @@ -538,7 +538,7 @@ pub trait Watcher: Sized {
/// file to the file being saved, you will just receive a single `Write` event.
///
/// If you use a delay of more than 30 seconds, you can avoid receiving repetitions of previous
/// events on OS X.
/// events on macOS.
///
/// # Disadvantages
///
Expand Down
2 changes: 1 addition & 1 deletion tests/debounce.rs
Original file line number Diff line number Diff line change
Expand Up @@ -895,7 +895,7 @@ fn modify_rename_directory() {
watcher.watch(tdir.mkpath("."), RecursiveMode::Recursive).expect("failed to watch directory");

tdir.chmod("dir1");
tdir.chmod("dir1"); // needed by os x
tdir.chmod("dir1"); // needed by macOS
tdir.rename("dir1", "dir2");

if cfg!(target_os="windows") {
Expand Down
2 changes: 1 addition & 1 deletion tests/notify.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ fn test_inflate_events() {
fn create_file() {
let tdir = TempDir::new("temp_dir").expect("failed to create temporary directory");

// OSX FsEvent needs some time to discard old events from its log.
// macOS FsEvent needs some time to discard old events from its log.
sleep_macos(10);

let (tx, rx) = mpsc::channel();
Expand Down
4 changes: 2 additions & 2 deletions tests/utils/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ pub fn sleep(duration: u64) {
thread::sleep(Duration::from_millis(duration));
}

// Sleep for `duration` in milliseconds if running on OS X
// Sleep for `duration` in milliseconds if running on macOS
pub fn sleep_macos(duration: u64) {
if cfg!(target_os = "macos") {
thread::sleep(Duration::from_millis(duration));
Expand All @@ -112,7 +112,7 @@ pub trait TestHelpers {
fn create_all(&self, paths: Vec<&str>);
/// Rename file or directory.
fn rename(&self, a: &str, b: &str);
/// Toggle "other" rights on linux and os x and "readonly" on windows
/// Toggle "other" rights on linux and macOS and "readonly" on windows
fn chmod(&self, p: &str);
/// Write some data to a file
fn write(&self, p: &str);
Expand Down

0 comments on commit 9bbe322

Please sign in to comment.