Merge pull request #6049 from dalg24/build_md

Trim down build.md document
sandialabs · Apr 12, 2023 · 72687d8 · 72687d8
2 parents 48b34de + d0f5777
commit 72687d8
Showing 1 changed file with 1 addition and 244 deletions.
diff --git a/BUILD.md b/BUILD.md
@@ -111,247 +111,4 @@ For dev-build details, consult the kokkos-spack repository [README](https://gith
 
 # Kokkos Keyword Listing
 
-## Device Backends
-Device backends can be enabled by specifying `-DKokkos_ENABLE_X`.
-
-* Kokkos_ENABLE_CUDA
-    * Whether to build CUDA backend
-    * BOOL Default: OFF
-* Kokkos_ENABLE_HPX
-    * Whether to build HPX backend (experimental)
-    * BOOL Default: OFF
-* Kokkos_ENABLE_OPENMP
-    * Whether to build OpenMP backend
-    * BOOL Default: OFF
-* Kokkos_ENABLE_THREADS
-    * Whether to build C++ thread backend
-    * BOOL Default: OFF
-* Kokkos_ENABLE_SERIAL
-    * Whether to build serial backend
-    * BOOL Default: ON
-* Kokkos_ENABLE_HIP (Experimental)
-    * Whether to build HIP backend
-    * BOOL Default: OFF
-* Kokkos_ENABLE_OPENMPTARGET (Experimental)
-    * Whether to build the OpenMP target backend
-    * BOOL Default: OFF
-
-## Enable Options
-Options can be enabled by specifying `-DKokkos_ENABLE_X`.
-
-* Kokkos_ENABLE_AGGRESSIVE_VECTORIZATION
-    * Whether to aggressively vectorize loops
-    * BOOL Default: OFF
-* Kokkos_ENABLE_COMPILER_WARNINGS
-    * Whether to print all compiler warnings
-    * BOOL Default: OFF
-* Kokkos_ENABLE_CUDA_CONSTEXPR
-    * Whether to activate experimental relaxed constexpr functions
-    * BOOL Default: OFF
-* Kokkos_ENABLE_CUDA_LAMBDA
-    * Whether to activate experimental lambda features
-    * BOOL Default: OFF
-* Kokkos_ENABLE_CUDA_LDG_INTRINSIC
-    * Deprecated since 4.0, LDG intrinsics are always enabled.
-    * Whether to use CUDA LDG intrinsics
-    * BOOL Default: OFF
-* Kokkos_ENABLE_CUDA_RELOCATABLE_DEVICE_CODE
-    * Whether to enable relocatable device code (RDC) for CUDA
-    * BOOL Default: OFF
-* Kokkos_ENABLE_CUDA_UVM
-    * Deprecated since 4.0
-    * Whether to use unified memory (UM) by default for CUDA
-    * BOOL Default: OFF
-* Kokkos_ENABLE_DEBUG
-    * Whether to activate extra debug features - may increase compile times
-    * BOOL Default: OFF
-* Kokkos_ENABLE_DEBUG_BOUNDS_CHECK
-    * Whether to use bounds checking - will increase runtime
-    * BOOL Default: OFF
-* Kokkos_ENABLE_DEBUG_DUALVIEW_MODIFY_CHECK
-    * Debug check on dual views
-    * BOOL Default: OFF
-* Kokkos_ENABLE_EXAMPLES
-    * Whether to enable building examples
-    * BOOL Default: OFF
-* Kokkos_ENABLE_IMPL_HPX_ASYNC_DISPATCH
-    * Whether HPX supports asynchronous dispatch
-    * BOOL Default: ON
-* Kokkos_ENABLE_IMPL_CUDA_MALLOC_ASYNC
-    * Whether to enable CudaMallocAsync (requires CUDA Toolkit 11.2). This is an experimental performance feature and currently has issue when using with UCX. See https://github.com/kokkos/kokkos/issues/4228 for more details.
-    * BOOL Default: OFF
-* Kokkos_ENABLE_LARGE_MEM_TESTS
-    * Whether to perform extra large memory tests
-    * BOOL_Default: OFF
-* Kokkos_ENABLE_PROFILING_LOAD_PRINT
-    * Whether to print information about which profiling tools gotloaded
-    * BOOL Default: OFF
-* Kokkos_ENABLE_TESTS
-    * Whether to enable test suite
-    * BOOL Default: OFF
-
-
-## Third-party Libraries (TPLs)
-The following options control enabling TPLs:
-* Kokkos_ENABLE_HPX
-    * Whether to enable the HPX library
-    * BOOL Default: OFF
-* Kokkos_ENABLE_HWLOC
-    * Whether to enable the HWLOC library
-    * BOOL Default: Off
-* Kokkos_ENABLE_LIBNUMA
-    * Whether to enable the LIBNUMA library
-    * BOOL Default: Off
-* Kokkos_ENABLE_MEMKIND
-    * Whether to enable the MEMKIND library
-    * BOOL Default: Off
-* Kokkos_ENABLE_LIBDL
-    * Whether to enable the LIBDL library
-    * BOOL Default: On
-* Kokkos_ENABLE_LIBRT
-    * Whether to enable the LIBRT library
-    * BOOL Default: Off
-
-The following options control finding and configuring non-CMake TPLs:
-* Kokkos_CUDA_DIR or CUDA_ROOT
-    * Location of CUDA install prefix for libraries
-    * PATH Default:
-* Kokkos_HWLOC_DIR or HWLOC_ROOT
-    * Location of HWLOC install prefix
-    * PATH Default:
-* Kokkos_LIBNUMA_DIR or LIBNUMA_ROOT
-    * Location of LIBNUMA install prefix
-    * PATH Default:
-* Kokkos_MEMKIND_DIR or MEMKIND_ROOT
-    * Location of MEMKIND install prefix
-    * PATH Default:
-* Kokkos_LIBDL_DIR or LIBDL_ROOT
-    * Location of LIBDL install prefix
-    * PATH Default:
-* Kokkos_LIBRT_DIR or LIBRT_ROOT
-    * Location of LIBRT install prefix
-    * PATH Default:
-
-The following options control `find_package` paths for CMake-based TPLs:
-* HPX_DIR or HPX_ROOT
-    * Location of HPX prefix (ROOT) or CMake config file (DIR)
-    * PATH Default:
-
-## Architecture Keywords
-Architecture-specific optimizations can be enabled by specifying `-DKokkos_ARCH_X`.
-
-* Kokkos_ARCH_NATIVE
-    * Whether to optimize for the the local CPU architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_AMDAVX
-    * Whether to optimize for the AMDAVX architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_ARMV80
-    * Whether to optimize for the ARMV80 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_ARMV81
-    * Whether to optimize for the ARMV81 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_ARMV8_THUNDERX
-    * Whether to optimize for the ARMV8_THUNDERX architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_ARMV8_TX2
-    * Whether to optimize for the ARMV8_TX2 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_BDW
-    * Whether to optimize for the BDW architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_BGQ
-    * Whether to optimize for the BGQ architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_ZEN
-    * Whether to optimize for the Zen architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_ZEN2
-    * Whether to optimize for the Zen2 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_ZEN3
-    * Whether to optimize for the Zen3 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_HSW
-    * Whether to optimize for the HSW architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_KEPLER30
-    * Whether to optimize for the KEPLER30 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_KEPLER32
-    * Whether to optimize for the KEPLER32 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_KEPLER35
-    * Whether to optimize for the KEPLER35 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_KEPLER37
-    * Whether to optimize for the KEPLER37 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_KNC
-    * Whether to optimize for the KNC architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_KNL
-    * Whether to optimize for the KNL architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_MAXWELL50
-    * Whether to optimize for the MAXWELL50 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_MAXWELL52
-    * Whether to optimize for the MAXWELL52 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_MAXWELL53
-    * Whether to optimize for the MAXWELL53 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_PASCAL60
-    * Whether to optimize for the PASCAL60 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_PASCAL61
-    * Whether to optimize for the PASCAL61 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_POWER7
-    * Whether to optimize for the POWER7 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_POWER8
-    * Whether to optimize for the POWER8 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_POWER9
-    * Whether to optimize for the POWER9 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_ICL
-    * Whether to optimize for the ICL architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_ICX
-    * Whether to optimize for the ICX architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_SKL
-    * Whether to optimize for the SKL architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_SKX
-    * Whether to optimize for the SKX architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_SNB
-    * Whether to optimize for the SNB architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_SPR
-    * Whether to optimize for the SPR architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_TURING75
-    * Whether to optimize for the TURING75 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_VOLTA70
-    * Whether to optimize for the VOLTA70 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_VOLTA72
-    * Whether to optimize for the VOLTA72 architecture
-    * BOOL Default: OFF
-* Kokkos_ARCH_WSM
-    * Whether to optimize for the WSM architecture
-    * BOOL Default: OFF
-
-##### [LICENSE](https://github.com/kokkos/kokkos/blob/devel/LICENSE)
-
-[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
-
-Under the terms of Contract DE-NA0003525 with NTESS,
-the U.S. Government retains certain rights in this software.
+Please refer to our [wiki](https://kokkos.github.io/kokkos-core-wiki/keywords.html#cmake-keywords).