Documentation around alpaka_INSTALL

alpaka-group · Feb 12, 2025 · 95c0bf2 · 95c0bf2
1 parent 1112fb4
commit 95c0bf2
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -162,7 +162,7 @@ endif()
 ################################################################################
 # Installation.
 
-option(alpaka_INSTALL "" OFF)
+option(alpaka_INSTALL "install alpaka even if used as project dependency" OFF)
 # Do not install if alpaka is used as a CMake subdirectory
 if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME OR alpaka_INSTALL)
     include(CMakePackageConfigHelpers)

diff --git a/docs/source/advanced/cmake.rst b/docs/source/advanced/cmake.rst
@@ -178,6 +178,12 @@ alpaka_USE_MDSPAN
      "SYSTEM" - Enable mdspan and acquire it via `find_package` from your system
      "FETCH" - Enable mdspan and download it via CMake's `FetchContent` from GitHub. The dependency will not be installed when you install alpaka.
 
+alpaka_INSTALL
+  .. code-block::
+
+     Install alpaka even if it is a project dependency.
+     Defaults to off (i.e. alpaka is not installed separately if alpaka is a project dependency).
+
 .. _cpu-serial:
 
 CPU Serial