Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Documentation updated abour cache_dir:
 - Context constructor: new param cache_dir
 - Program.build actualized: old param cache_dir described with taking into account Context cache_dir
  • Loading branch information
PolarNick239 committed Nov 16, 2015
1 parent 06b2088 commit 7522c12
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions doc/runtime.rst
Expand Up @@ -124,7 +124,7 @@ Platforms, Devices and Contexts

Two instances of this class may be compared using *=="* and *"!="*.

.. class:: Context(devices=None, properties=None, dev_type=None)
.. class:: Context(devices=None, properties=None, dev_type=None, cache_dir=None)

Create a new context. *properties* is a list of key-value
tuples, where each key must be one of :class:`context_properties`.
Expand All @@ -134,6 +134,9 @@ Platforms, Devices and Contexts
If neither is specified, a context with a *dev_type* of
:attr:`device_type.DEFAULT` is created.

If *cache_dir* is not `None` - it will be used as default *cache_dir*
for all its' :class:`Program` instances builds (see also :meth:`Program.build`).

.. note::

Calling the constructor with no arguments will fail for recent
Expand Down Expand Up @@ -654,12 +657,17 @@ Programs and Kernels

See :class:`program_build_info` for values of *param*.

.. method:: build(options=[], devices=None)
.. method:: build(options=[], devices=None, cache_dir=None)

*options* is a string of compiler flags.
Returns *self*.

By default, built binaries are cached in an on-disk cache called
If *cache_dir* is not None - built binaries are cached in an on-disk cache
with given path.
If passed *cache_dir* is None, but context of this program was created with
not-None cache_dir - it will be used as cache directory.
If passed *cache_dir* is None and context was created with None cache_dir:
built binaries will be cached in an on-disk cache called
:file:`pyopencl-compiler-cache-vN-uidNAME-pyVERSION` in the directory
returned by :func:`tempfile.gettempdir`. By setting the environment
variable :envvar:`PYOPENCL_NO_CACHE` to any non-empty value, this
Expand Down

0 comments on commit 7522c12

Please sign in to comment.