From 3822b20319536cae6cf1c4b9bf301f778ba2ae82 Mon Sep 17 00:00:00 2001 From: Alexey Tumanov Date: Tue, 18 Dec 2018 14:45:24 -0800 Subject: [PATCH] [doc] update testing and dev instructions (#3562) * [doc] update python testing command * update installation/dev instructions --- doc/source/installation.rst | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/doc/source/installation.rst b/doc/source/installation.rst index 0d1d4955d..59cef7334 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -120,7 +120,8 @@ that you've cloned the git repository. .. code-block:: bash - python test/runtest.py + export PYTHONPATH="$PYTHONPATH:./test/" + python -m pytest test/runtest.py Cleaning the source tree ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -131,4 +132,18 @@ The source tree can be cleaned by running git clean -f -f -x -d -in the ``ray/`` directory. +in the ``ray/`` directory. Warning: this command will delete all untracked files +and directories and will reset the repository to its checked out state. +For a shallower working directory cleanup, you may want to try: + +.. code-block:: bash + + rm -rf ./build + +under ``ray/``. Incremental builds should work as follows: + +.. code-block:: bash + + pushd ./build && make && popd + +under ``ray/``.