tyler.durden
/
powerline
mirror of https://github.com/powerline/powerline.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation

This commit is contained in:
ZyX 2014-09-02 21:49:23 +04:00
parent a4667c9a76
commit 986a69481f
3 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/source/configuration/reference.rst
View File

@ -45,6 +45,7 @@ Common configuration is a subdictionary that is a value of ``common`` key in
auto Selects most performant watcher. auto Selects most performant watcher.
inotify Select inotify watcher. Linux only. inotify Select inotify watcher. Linux only.
stat Select stat-based polling watcher. stat Select stat-based polling watcher.
uv Select libuv-based watcher.
======= =================================== ======= ===================================
Default is ``auto``. Default is ``auto``.

2
docs/source/installation.rst
View File

@ -19,6 +19,8 @@ Generic requirements
repositories. repositories.
* ``bzr`` python package (note: *not* standalone executable). Required to work * ``bzr`` python package (note: *not* standalone executable). Required to work
with bazaar repositories. with bazaar repositories.
* ``pyuv`` python package. Required for :ref:`libuv-based watcher
<config-common-watcher>` to work.
* ``i3-py``, `available on github <https://github.com/ziberna/i3-py>`_. Required * ``i3-py``, `available on github <https://github.com/ziberna/i3-py>`_. Required
for i3wm bindings and segments. for i3wm bindings and segments.

17
powerline/lib/watcher/__init__.py
View File

@ -18,16 +18,17 @@ def create_file_watcher(pl, watcher_type='auto', expire_time=10):
Use ``.unwatch()`` method of the returned object to stop watching the file. Use ``.unwatch()`` method of the returned object to stop watching the file.
Uses inotify if available, otherwise tracks mtimes. expire_time is the Uses inotify if available, then pyuv, otherwise tracks mtimes. expire_time
number of minutes after the last query for a given path for the inotify is the number of minutes after the last query for a given path for the
watch for that path to be automatically removed. This conserves kernel inotify watch for that path to be automatically removed. This conserves
resources. kernel resources.
:param PowerlineLogger pl: :param PowerlineLogger pl:
Logger. Logger.
:param str watcher_type: :param str watcher_type
One of ``inotify`` (linux only), ``stat``, ``auto``. Determines what One of ``inotify`` (linux only), ``uv``, ``stat``, ``auto``. Determines
watcher will be used. ``auto`` will use ``inotify`` if available. what watcher will be used. ``auto`` will use ``inotify`` if available,
then ``libuv`` and then fall back to ``stat``.
:param int expire_time: :param int expire_time:
Number of minutes since last ``.__call__()`` before inotify watcher will Number of minutes since last ``.__call__()`` before inotify watcher will
stop watching given file. stop watching given file.
@ -67,7 +68,7 @@ def create_tree_watcher(pl, watcher_type='auto', expire_time=10):
Logger. Logger.
:param str watcher_type: :param str watcher_type:
Watcher type. Currently the only supported types are ``inotify`` (linux Watcher type. Currently the only supported types are ``inotify`` (linux
only), ``dummy`` and ``auto``. only), ``uv``, ``dummy`` and ``auto``.
:param int expire_time: :param int expire_time:
Number of minutes since last ``.__call__()`` before inotify watcher will Number of minutes since last ``.__call__()`` before inotify watcher will
stop watching given file. stop watching given file.