update docuementation

MarcelKoch · Dec 3, 2024 · 95926aa · 95926aa
1 parent a5ad85c
commit 95926aa
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -33,9 +33,9 @@ option(GINKGO_FAST_TESTS "Reduces the input size for a few tests known to be tim
 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_ENABLE_HALF "Enable the use of half precision" ON)
-# We do not support MSVC.
+# We do not support half precision in MSVC.
 if(MSVC)
-    message(STATUS "HALF is not supported in MSVC")
+    message(STATUS "We do not support half precision in MSVC.")
     set(GINKGO_ENABLE_HALF OFF CACHE BOOL "Enable the use of half precision" FORCE)
 endif()
 option(GINKGO_SKIP_DEPENDENCY_UPDATE

diff --git a/INSTALL.md b/INSTALL.md
@@ -25,6 +25,8 @@ Ginkgo adds the following additional switches to control what is being built:
     instead of converting data on the fly, default is `OFF`.
     Enabling this flag increases the library size, but improves performance of
     mixed-precision kernels.
+*   `-DGINKGO_ENABLE_HALF={ON, OFF}` enable half precision support in Ginkgo, default is `ON`.
+    It is `OFF` when the compiler is MSVC.
 *   `-DGINKGO_BUILD_TESTS={ON, OFF}` builds Ginkgo's tests
     (will download googletest), default is `ON`.
 *   `-DGINKGO_FAST_TESTS={ON, OFF}` reduces the input sizes for a few slow tests