Skip to content

Commit

Permalink
moved keyword descriptions to the build section
Browse files Browse the repository at this point in the history
  • Loading branch information
JBludau committed Dec 18, 2024
1 parent afe39d9 commit 5f78dc6
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 10 deletions.
10 changes: 8 additions & 2 deletions docs/source/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,14 @@ which activates the OpenMP backend. All the options controlling device backends,
## Advanced Build Options

Kokkos allows projects to specify if they want Kokkos to set the `CXX` compiler in a way that allows the build system to work independent of the used backend.
This is controlled via the options `Kokkos_GLOBAL_COMPILATION` and `Kokkos_FORCE_COMPILER_LAUNCHER` described in the [CMake Keywords](../keywords).
Additionally there are minimal working examples in the `example` folder.
This is controlled via the options `Kokkos_GLOBAL_COMPILATION` and `Kokkos_FORCE_COMPILER_LAUNCHER` that have to be set before `find_package(Kokkos)` is called.

| | Description | Default |
|---|-------------|---------|
| `Kokkos_GLOBAL_COMPILATION` | Set compiler to the CXX compiler Kokkos needs for the whole project | `ON` |
| `Kokkos_FORCE_COMPILER_LAUNCHER` | Use the `kokkos_compiler_launcher` script on all targets in the project. Redirects cpp files in targets that link to Kokkos to the CXX compiler Kokkos needs and to the respective CMake detected compiler otherwise | `OFF` |

Minimal working examples can be found in the `example` folder.

## Known Issues<a name="KnownIssues"></a>

Expand Down
8 changes: 0 additions & 8 deletions docs/source/keywords.rst
Original file line number Diff line number Diff line change
Expand Up @@ -163,14 +163,6 @@ General options
* Aggressively vectorize loops
* ``OFF``

* * ``Kokkos_GLOBAL_COMPILATION``
* Set compiler to the CXX compiler Kokkos needs for the whole project
* ``ON``

* * ``Kokkos_FORCE_COMPILER_LAUNCHER``
* Use the kokkos_compiler_launcher script on all targets in the project. Redirects files in targets that link to Kokkos to the CXX compiler Kokkos needs.
* ``OFF``

Debugging
---------
.. list-table::
Expand Down

0 comments on commit 5f78dc6

Please sign in to comment.