Help/envvar/SYCLCXX.rst

SYCLCXX
-------

.. versionadded:: 4.5

.. note::
   Experimental. Gated by ``CMAKE_EXPERIMENTAL_SYCL``.

.. include:: include/ENV_VAR.rst

Preferred executable for compiling ``SYCL`` language files. Will only be used
by CMake on the first configuration to determine the ``SYCL`` compiler, after
which the value for ``SYCL`` is stored in the cache as
:variable:`CMAKE_SYCL_COMPILER <CMAKE_<LANG>_COMPILER>`. For any configuration
run (including the first), the environment variable will be ignored if the
:variable:`CMAKE_SYCL_COMPILER <CMAKE_<LANG>_COMPILER>` variable is defined.

.. note::
  Options that are required to make the compiler work correctly can be included;
  they can not be changed.

.. code-block:: console

  $ export SYCLCXX="custom-compiler --arg1 --arg2"