Skip to content

Commit 0ef68e9

Browse files
committed
Update docs: the compilation cache is enabled by default
1 parent 511d5a0 commit 0ef68e9

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/how-to/hip_rtc.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -265,17 +265,17 @@ Use the following environment variables to manage the cache status as enabled or
265265
disabled, the location for storing the cache contents, and the cache eviction
266266
policy:
267267

268-
* ``AMD_COMGR_CACHE`` By default this variable has a value of ``0`` and the
269-
compilation cache feature is disabled. To enable the feature set the
270-
environment variable to a value of ``1`` (or any value other than ``0``).
268+
* ``AMD_COMGR_CACHE`` By default this variable is unset and the
269+
compilation cache feature is enabled. To disable the feature set the
270+
environment variable to a value of ``0``.
271271

272272
* ``AMD_COMGR_CACHE_DIR``: By default the value of this environment variable is
273-
defined as ``$XDG_CACHE_HOME/comgr_cache``, which defaults to
274-
``$USER/.cache/comgr_cache`` on Linux, and ``%LOCALAPPDATA%\cache\comgr_cache``
273+
defined as ``$XDG_CACHE_HOME/comgr``, which defaults to
274+
``$USER/.cache/comgr`` on Linux, and ``%LOCALAPPDATA%\cache\comgr``
275275
on Windows. You can specify a different directory for the environment variable
276276
to change the path for cache storage. If the runtime fails to access the
277-
specified cache directory, or the environment variable is set to an empty
278-
string (""), the cache is disabled.
277+
specified cache directory the cache is disabled. If the environment variable
278+
is set to an empty string (``""``), the default directory is used.
279279

280280
* ``AMD_COMGR_CACHE_POLICY``: If assigned a value, the string is interpreted and
281281
applied to the cache pruning policy. The string format is consistent with

0 commit comments

Comments
 (0)