Skip to content

Commit 5ef4f0b

Browse files
authored
add intel:installation_path docs (#4207)
1 parent d9b7855 commit 5ef4f0b

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

reference/tools/intel.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,14 @@ This generator creates a ``conanintelsetvars.sh|bat`` wrapping the Intel script
2727
environment variables needed. That script is the first step to start using the Intel compilers because it's setting some
2828
important variables in your local environment.
2929

30+
.. note::
31+
32+
If you explicitly set ``tools.intel:installation_path=""`` configuration
33+
(empty string), Conan will **not generate** the ``conanintelsetvars``
34+
script. In this case, you are expected to have already activated the Intel
35+
oneAPI environment manually.
36+
37+
3038
In summary, the ``IntelCC`` generator:
3139

3240
#. Reads your profile ``[settings]`` and ``[conf]``.
@@ -142,7 +150,10 @@ conf
142150

143151
``IntelCC`` uses these :ref:`configuration entries <reference_config_files_global_conf>`:
144152

145-
- ``tools.intel:installation_path``: **(required)** argument to tell Conan the installation path, if it's not defined,
146-
Conan will try to find it out automatically.
153+
- ``tools.intel:installation_path``: **(required)** argument to tell Conan the
154+
installation path, if it's not defined, Conan will try to find it out
155+
automatically. If it is explicitly set to the empty string (``""``), Conan
156+
will **skip the generation** of the ``conanintelsetvars`` script, assuming the
157+
Intel environment has already been activated manually.
147158
- ``tools.intel:setvars_args``: **(optional)** it is used to pass whatever we want as arguments to our `setvars.sh|bat` file.
148159
You can check out all the possible ones from the Intel official documentation.

0 commit comments

Comments
 (0)