Skip to content

Commit

Permalink
Update installation.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
BoboTiG authored Mar 18, 2023
1 parent 71f2df3 commit 989fddc
Showing 1 changed file with 1 addition and 19 deletions.
20 changes: 1 addition & 19 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ Installing from the code repository

Dependencies
------------

|project_name| depends on many libraries to do its job. The following is
a list of dependencies you need based on the operating system you are
using.
Expand All @@ -66,21 +67,6 @@ using the ``watchmedo`` utility.
| PyYAML_ | Yes | Yes | Yes | Yes |
+---------------------+-------------+-------------+--------+-------------+

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

brew install libyaml

On Linux, use your favorite package manager to install LibYAML. Here's how you
do it on Ubuntu::

sudo apt install libyaml-dev

On Windows, please install PyYAML_ using the binaries they provide.


Supported Platforms (and Caveats)
---------------------------------
|project_name| uses native APIs as much as possible falling back
Expand All @@ -92,7 +78,6 @@ supported:
.. WARNING:: Differences between behaviors of these native API
are noted below.


Linux 2.6+
Linux kernel version 2.6 and later come with an API called inotify_
that programs can use to monitor file system events.
Expand All @@ -104,7 +89,6 @@ Linux 2.6+

fs.inotify.max_user_watches=16384


macOS
The Darwin kernel/OS X API maintains two ways to monitor directories
for file system events:
Expand All @@ -123,7 +107,6 @@ macOS
in `BSD Unix variants`_. Much of this information applies to
macOS as well.


_`BSD Unix variants`
BSD variants come with kqueue_ which programs can use to monitor
changes to open file descriptors. Because of the way ``kqueue(2)`` works,
Expand All @@ -144,7 +127,6 @@ _`BSD Unix variants`

ulimit -n 1024


Windows Vista and later
The Windows API provides the ReadDirectoryChangesW_. |project_name|
currently contains implementation for a synchronous approach requiring
Expand Down

0 comments on commit 989fddc

Please sign in to comment.