Adjust comment and doc

rapidsai · Oct 30, 2024 · fd007ee · fd007ee
1 parent 52aa6ae
commit fd007ee
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 7 deletions.
diff --git a/cpp/include/cudf/io/config_utils.hpp b/cpp/include/cudf/io/config_utils.hpp
@@ -37,11 +37,11 @@ bool is_gds_enabled();
 bool is_kvikio_enabled();
 
 /**
- * @brief Set kvikIO parameters, including:
+ * @brief Set KvikIO parameters, including:
+ * - Compatibility mode, according to the environment variable KVIKIO_COMPAT_MODE. If
+ *   KVIKIO_COMPAT_MODE is not set, enable it by default, which enforces the use of POSIX I/O.
  * - Thread pool size, according to the environment variable KVIKIO_NTHREADS. If KVIKIO_NTHREADS is
  *   not set, use 4 threads by default.
- * - Compatibility mode, according to the environment variable KVIKIO_COMPAT_MODE. If
- *   KVIKIO_COMPAT_MODE is not set, set it to ON by default.
  */
 void set_up_kvikio();
 

diff --git a/docs/cudf/source/user_guide/io/io.md b/docs/cudf/source/user_guide/io/io.md
@@ -101,10 +101,9 @@ There are four valid values for the environment variable:
 fall back to the GDS compatibility mode.
 - "ALWAYS": Enable GDS use. If the cuFile library cannot be properly loaded,
 throw an exception.
-- "KVIKIO": Enable GDS through [KvikIO](https://github.com/rapidsai/kvikio). Note
-that if the environment variable `KVIKIO_COMPAT_MODE` is `ON`, or if KvikIO detects
-that the system is not properly configured for GDS, the I/O will fall back to the
-GDS compatibility mode.
+- "KVIKIO": Enable GDS through [KvikIO](https://github.com/rapidsai/kvikio). If
+KvikIO detects that the system is not properly configured for GDS, the I/O will
+fall back to the GDS compatibility mode.
 - "OFF": Completely disable GDS use.
 
 If no value is set, behavior will be the same as the "KVIKIO" option.