Skip to content

Commit

Permalink
s/Mac OS X/macOS/
Browse files Browse the repository at this point in the history
  • Loading branch information
BoboTiG committed Oct 1, 2021
1 parent 2325b00 commit 9c61301
Show file tree
Hide file tree
Showing 9 changed files with 31 additions and 31 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Installation Caveats

The ``watchmedo`` script depends on PyYAML_ which links with LibYAML_,
which brings a performance boost to the PyYAML parser. However, installing
LibYAML_ is optional but recommended. On Mac OS X, you can use homebrew_
LibYAML_ is optional but recommended. On macOS, you can use homebrew_
to install LibYAML:

.. code-block:: bash
Expand Down Expand Up @@ -186,7 +186,7 @@ Supported Platforms
-------------------

* Linux 2.6 (inotify)
* Mac OS X (FSEvents, kqueue)
* macOS (FSEvents, kqueue)
* FreeBSD/BSD (kqueue)
* Windows (ReadDirectoryChangesW with I/O completion ports;
ReadDirectoryChangesW worker threads)
Expand Down
2 changes: 1 addition & 1 deletion docs/source/global.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
.. _kqueue: https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2
.. _FSEvents: https://developer.apple.com/library/mac/#documentation/Darwin/Conceptual/FSEvents_ProgGuide/Introduction/Introduction.html
.. _inotify: https://linux.die.net/man/7/inotify
.. _Mac OS X File System Monitoring Performance Guidelines: https://developer.apple.com/library/ios/#documentation/Performance/Conceptual/FileSystem/Articles/TrackingChanges.html
.. _macOS File System Monitoring Performance Guidelines: https://developer.apple.com/library/ios/#documentation/Performance/Conceptual/FileSystem/Articles/TrackingChanges.html
.. _ReadDirectoryChangesW: https://docs.microsoft.com/windows/win32/api/winbase/nf-winbase-readdirectorychangesw
.. _GetQueuedCompletionStatus: https://docs.microsoft.com/windows/win32/api/ioapiset/nf-ioapiset-getqueuedcompletionstatus
.. _CreateIoCompletionPort: https://docs.microsoft.com/windows/win32/api/ioapiset/nf-ioapiset-createiocompletionport
Expand Down
2 changes: 1 addition & 1 deletion docs/source/hacking.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ beginning to hack:

1. Python_
2. git_
3. XCode_ (on Mac OS X)
3. XCode_ (on macOS)

Setting up the Work Environment
-------------------------------
Expand Down
32 changes: 16 additions & 16 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,27 +49,27 @@ Dependencies
a list of dependencies you need based on the operating system you are
using.

+---------------------+-------------+-------------+-------------+-------------+
| Operating system | Windows | Linux 2.6 | Mac OS X/ | BSD |
| Dependency (row) | | | Darwin | |
+=====================+=============+=============+=============+=============+
| XCode_ | | | Yes | |
+---------------------+-------------+-------------+-------------+-------------+
+---------------------+-------------+-------------+--------+-------------+
| Operating system | Windows | Linux 2.6 | macOS | BSD |
| Dependency (row) | | | Darwin | |
+=====================+=============+=============+========+=============+
| XCode_ | | | Yes | |
+---------------------+-------------+-------------+--------+-------------+

The following is a list of dependencies you need based on the operating system you are
using the ``watchmedo`` utility.

+---------------------+-------------+-------------+-------------+-------------+
| Operating system | Windows | Linux 2.6 | Mac OS X/ | BSD |
| Dependency (row) | | | Darwin | |
+=====================+=============+=============+=============+=============+
| PyYAML_ | Yes | Yes | Yes | Yes |
+---------------------+-------------+-------------+-------------+-------------+
+---------------------+-------------+-------------+--------+-------------+
| Operating system | Windows | Linux 2.6 | macOS | BSD |
| Dependency (row) | | | Darwin | |
+=====================+=============+=============+========+=============+
| PyYAML_ | Yes | Yes | Yes | Yes |
+---------------------+-------------+-------------+--------+-------------+

Installing Dependencies
~~~~~~~~~~~~~~~~~~~~~~~
The ``watchmedo`` script depends on PyYAML_ which links with LibYAML_.
On Mac OS X, you can use homebrew_ to install LibYAML::
On macOS, you can use homebrew_ to install LibYAML::

brew install libyaml

Expand Down Expand Up @@ -105,7 +105,7 @@ Linux 2.6+
fs.inotify.max_user_watches=16384


Mac OS X
macOS
The Darwin kernel/OS X API maintains two ways to monitor directories
for file system events:

Expand All @@ -115,13 +115,13 @@ Mac OS X
|project_name| can use whichever one is available, preferring
FSEvents over ``kqueue(2)``. ``kqueue(2)`` uses open file descriptors for monitoring
and the current implementation uses
`Mac OS X File System Monitoring Performance Guidelines`_ to open
`macOS File System Monitoring Performance Guidelines`_ to open
these file descriptors only to monitor events, thus allowing
OS X to unmount volumes that are being watched without locking them.

.. NOTE:: More information about how |project_name| uses ``kqueue(2)`` is noted
in `BSD Unix variants`_. Much of this information applies to
Mac OS X as well.
macOS as well.


_`BSD Unix variants`
Expand Down
4 changes: 2 additions & 2 deletions src/watchdog/observers/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@
Class Platforms Note
============== ================================ ==============================
|Inotify| Linux 2.6.13+ ``inotify(7)`` based observer
|FSEvents| Mac OS X FSEvents based observer
|Kqueue| Mac OS X and BSD with kqueue(2) ``kqueue(2)`` based observer
|FSEvents| macOS FSEvents based observer
|Kqueue| macOS and BSD with kqueue(2) ``kqueue(2)`` based observer
|WinApi| MS Windows Windows API-based observer
|Polling| Any fallback implementation
============== ================================ ==============================
Expand Down
4 changes: 2 additions & 2 deletions src/watchdog/observers/fsevents.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
:synopsis: FSEvents based emitter implementation.
:author: yesudeep@google.com (Yesudeep Mangalapilly)
:author: contact@tiger-222.fr (Mickaël Schoentgen)
:platforms: Mac OS X
:platforms: macOS
"""

import time
Expand Down Expand Up @@ -57,7 +57,7 @@
class FSEventsEmitter(EventEmitter):

"""
Mac OS X FSEvents Emitter class.
macOS FSEvents Emitter class.
:param event_queue:
The event queue to fill with events.
Expand Down
4 changes: 2 additions & 2 deletions src/watchdog/observers/fsevents2.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"""
:module: watchdog.observers.fsevents2
:synopsis: FSEvents based emitter implementation.
:platforms: Mac OS X
:platforms: macOS
"""

import os
Expand Down Expand Up @@ -225,7 +225,7 @@ def queue_events(self, timeout):
self.queue_event(DirModifiedEvent(os.path.dirname(event.path)))
# TODO: generate events for tree

elif event.is_modified or event.is_inode_meta_mod or event.is_xattr_mod :
elif event.is_modified or event.is_inode_meta_mod or event.is_xattr_mod:
cls = DirModifiedEvent if event.is_directory else FileModifiedEvent
self.queue_event(cls(event.path))

Expand Down
6 changes: 3 additions & 3 deletions src/watchdog/observers/kqueue.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
:synopsis: ``kqueue(2)`` based emitter implementation.
:author: yesudeep@google.com (Yesudeep Mangalapilly)
:author: contact@tiger-222.fr (Mickaël Schoentgen)
:platforms: Mac OS X and BSD with kqueue(2).
:platforms: macOS and BSD with kqueue(2).
.. WARNING:: kqueue is a very heavyweight way to monitor file systems.
Each kqueue-detected directory modification triggers
Expand All @@ -32,7 +32,7 @@
.. ADMONITION:: About OS X performance guidelines
Quote from the `Mac OS X File System Performance Guidelines`_:
Quote from the `macOS File System Performance Guidelines`_:
"When you only want to track changes on a file or directory, be sure to
open it using the ``O_EVTONLY`` flag. This flag prevents the file or
Expand Down Expand Up @@ -62,7 +62,7 @@
:members:
:show-inheritance:
.. _Mac OS X File System Performance Guidelines:
.. _macOS File System Performance Guidelines:
http://developer.apple.com/library/ios/#documentation/Performance/Conceptual/FileSystem/Articles/TrackingChanges.html#//apple_ref/doc/uid/20001993-CJBJFIDD
"""
Expand Down
4 changes: 2 additions & 2 deletions src/watchdog/watchmedo.py
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ def schedule_tricks(observer, tricks, pathname, recursive):
help='[debug] forces Windows API'),
argument('--debug-force-fsevents',
default=False,
help='[debug] forces Mac OS X FSEvents'),
help='[debug] forces macOS FSEvents'),
argument('--debug-force-inotify',
default=False,
help='[debug] forces Linux inotify(7)')], cmd_aliases=['tricks'])
Expand Down Expand Up @@ -359,7 +359,7 @@ def tricks_generate_yaml(args):
help='[debug] forces Windows API'),
argument('--debug-force-fsevents',
default=False,
help='[debug] forces Mac OS X FSEvents'),
help='[debug] forces macOS FSEvents'),
argument('--debug-force-inotify',
default=False,
help='[debug] forces Linux inotify(7)')])
Expand Down

0 comments on commit 9c61301

Please sign in to comment.