Skip to content

Commit

Permalink
enable the option by default and update documentation
Browse files Browse the repository at this point in the history
Co-authored-by: Tobias Ribizel <ribizel@kit.edu>
Co-authored-by: Natalie Beams <246972+nbeams@users.noreply.github.com>
  • Loading branch information
3 people committed Nov 22, 2024
1 parent 1e0bb4c commit 96c9796
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
4 changes: 2 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ option(GINKGO_BUILD_DOC "Generate documentation" OFF)
option(GINKGO_FAST_TESTS "Reduces the input size for a few tests known to be time-intensive" OFF)
option(GINKGO_TEST_NONDEFAULT_STREAM "Uses non-default streams in CUDA and HIP tests" OFF)
option(GINKGO_MIXED_PRECISION "Instantiate true mixed-precision kernels (otherwise they will be conversion-based using implicit temporary storage)" OFF)
option(GINKGO_CUDA_CUSTOM_THRUST_NAMESPACE "Add custom namespace to thrust and cub in cuda to avoid potential break when the other libraries also uses thrust" OFF)
option(GINKGO_HIP_CUSTOM_THRUST_NAMESPACE "Add custom namespace to thrust in hip to avoid potential break when the other libraries also uses thrust" OFF)
option(GINKGO_CUDA_CUSTOM_THRUST_NAMESPACE "Add custom namespace to thrust and cub in cuda to avoid potential conflicts when other libraries also use thrust" ON)
option(GINKGO_HIP_CUSTOM_THRUST_NAMESPACE "Add custom namespace to thrust in hip to avoid potential conflicts when other libraries also use thrust" ON)
option(GINKGO_SKIP_DEPENDENCY_UPDATE
"Do not update dependencies each time the project is rebuilt" ON)
option(GINKGO_WITH_CLANG_TIDY "Make Ginkgo call `clang-tidy` to find programming issues." OFF)
Expand Down
10 changes: 4 additions & 6 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,10 @@ Ginkgo adds the following additional switches to control what is being built:
`OFF` otherwise.
* `-DCMAKE_HIP_ARCHITECTURES="gpuarch1;gpuarch2"` the AMDGPU targets to be passed to the compiler.
If empty, compiler chooses based on the available GPUs.
* `-DGINKGO_CUDA_CUSTOM_THRUST_NAMESPACE={ON, OFF}` adds custom namespace to thrust and the underlying cub in Ginkgo cuda.
Default is `OFF`. If encountering some weird issues only when using Ginkgo with other libraries using thrust or cub,
enabling this option may help.
* `-DGINKGO_HIP_CUSTOM_THRUST_NAMESPACE={ON, OFF}` adds custom namespace to thrust in Ginkgo hip.
Default is `OFF`. If encountering some weird issues only when using Ginkgo with other libraries using thrust or cub,
enabling this option may help.
* `-DGINKGO_CUDA_CUSTOM_THRUST_NAMESPACE={ON, OFF}` adds custom namespace to thrust and the underlying cub in Ginkgo CUDA.
Default is `ON`. It avoids the potential conflicts from thrust when other libraries also use thrust.
* `-DGINKGO_HIP_CUSTOM_THRUST_NAMESPACE={ON, OFF}` adds custom namespace to thrust in Ginkgo HIP.
Default is `ON`. It avoids the potential conflicts from thrust when other libraries also use thrust.
* `-DGINKGO_BUILD_HWLOC={ON, OFF}` builds Ginkgo with HWLOC. Default is `OFF`.
* `-DGINKGO_BUILD_DOC={ON, OFF}` creates an HTML version of Ginkgo's documentation
from inline comments in the code. The default is `OFF`.
Expand Down

0 comments on commit 96c9796

Please sign in to comment.