Merge pull request #1233 from ocaml/doc-watch

Document --watch flag
2018-09-07 09:58:35 +02:00 · 2018-09-07 09:58:35 +02:00 · 3c9cfbf1c0
parent 9409f46cc0 e7fe7c3114
commit 3c9cfbf1c0
1 changed files with 8 additions and 0 deletions
--- a/doc/usage.rst
+++ b/doc/usage.rst
@ -189,6 +189,14 @@ specific sub-directory and its children by using:
 -  ``dune build @foo/bar/runtest``
 -  ``dune runtest foo/bar``

+Watch mode
+==========
+
+The ``dune build`` and ``dune runtest`` commands support a ``-w`` (or
+``--watch``) flag. When it is passed, dune will perform the action as usual, and
+then wait for file changes and rebuild (or rerun the tests). This feature
+requires ``inotifywait`` or ``fswatch`` to be installed.
+
 Launching the Toplevel (REPL)
 =============================