Add Optional Fast Build Configuration (#8925)

* Fast builds by default

* Update doc/source/development.rst

Co-authored-by: Simon Mo <xmo@berkeley.edu>

Co-authored-by: Mehrdad <noreply@github.com>
Co-authored-by: Simon Mo <xmo@berkeley.edu>
This commit is contained in:
mehrdadn
2020-06-18 14:12:12 -07:00
committed by GitHub
co-authored by Simon Mo Mehrdad
parent 110f88ff61
commit 92f67cd2ae
5 changed files with 68 additions and 1 deletions
+30 -1
View File
@@ -23,7 +23,7 @@ changes you make to files in the Ray directory will not have any effect.
If you run into **Permission Denied** errors when running ``pip install``,
you can try adding ``--user``. You may also need to run something like ``sudo
chown -R $USER $HOME/anaconda3`` (substituting in the appropriate path).
chown -R "$USER" ~/anaconda3`` (substituting in the appropriate path).
If you make changes to the C++ or Python files, you will need to run the
build so C++ code is recompiled and/or Python files are redeployed in
@@ -38,6 +38,35 @@ the following:
This command is not enough to recompile all C++ unit tests. To do so, see
`Testing locally`_.
Fast, Debug, and Optimized Builds
---------------------------------
Currently, Ray is built with optimizations, which can take a long time and
interfere with debugging. To perform fast, debug, or optimized builds, you can
run the following (via ``-c`` ``fastbuild``/``dbg``/``opt``, respectively):
.. code-block:: shell
bazel build -c fastbuild //:ray_pkg
This will rebuild Ray with the appropriate options (which may take a while).
If you need to build all targets, you can use ``"//:*"`` instead of
``//:ray_pkg``.
To make this change permanent, you can add an option such as the following
line to your user-level ``~/.bazelrc`` file (not to be confused with the
workspace-level ``.bazelrc`` file):
.. code-block:: shell
build --compilation_mode=fastbuild
If you do so, remember to revert this change, unless you want it to affect
all of your development in the future.
Using ``dbg`` instead of ``fastbuild`` generates more debug information,
which can make it easier to debug with a debugger like ``gdb``.
.. _python-develop:
Developing Ray (Python Only)