add changelog for #29

Pylons · May 2, 2018 · daae543 · daae543
1 parent bd60103
commit daae543
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,3 +1,12 @@
+unreleased
+==========
+
+- Allow overriding the default monitor lookup by specifying the
+  ``HUPPER_DEFAULT_MONITOR`` environment variable as a Python dotted-path
+  to a monitor factory. For example,
+  ``HUPPER_DEFAULT_MONITOR=hupper.polling.PollingFileMonitor``.
+  See https://github.com/Pylons/hupper/pull/29
+
 1.1 (2018-03-29)
 ================
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -121,6 +121,19 @@ new files to watch. This can be done by acquiring a reference to the
 process. The :func:`hupper.start_reloader` function will return the instance
 or :func:`hupper.get_reloader` can be used as well.
 
+Overriding the default file monitor
+-----------------------------------
+
+By default, ``hupper`` will auto-select the best file monitor based on what
+is available. The preferred order is ``watchdog`` then ``polling``. If
+``watchdog`` is installed but you do not want to use it for any reason, you
+may override the default by specifying the monitor you wish to use instead in
+the ``HUPPER_DEFAULT_MONITOR`` environment variable. For example:
+
+.. code:: bash
+
+   $ HUPPER_DEFAULT_MONITOR=hupper.polling.PollingFileMonitor hupper -m foo
+
 More Information
 ================