From 65fac651e646f1f5a150bc8060e7a32eb3cd7f81 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andreas=20Kl=C3=B6ckner?= <inform@tiker.net>
Date: Wed, 17 Mar 2021 14:35:22 -0500
Subject: [PATCH] Clarify caching semantics (closes gh-443)
---
doc/runtime_program.rst | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/doc/runtime_program.rst b/doc/runtime_program.rst
index 8cb2077c..975ad9f7 100644
--- a/doc/runtime_program.rst
+++ b/doc/runtime_program.rst
@@ -10,8 +10,16 @@ Program
.. envvar:: PYOPENCL_NO_CACHE
+ By default, PyOpenCL will used cached "binaries" returned by the
+ OpenCL runtime when calling :meth:`Program.build` on a program
+ constructed with source. (It will depend on the ICD in use how much
+ compilation work is saved by this.)
By setting the environment variable :envvar:`PYOPENCL_NO_CACHE` to any
non-empty value, this caching is suppressed.
+
+ PyOpenCL will also cache "invokers", which are short snippets of Python
+ that are generated to accelerate passing arguments to and enqueuing
+ a kernel. For now, this caching is unaffected by ``PYOPENCL_NO_CACHE``.
.. versionadded:: 2013.1
--
GitLab