diff --git a/cpp/doxygen/main_page.md b/cpp/doxygen/main_page.md index a3659e7460..22bab7c861 100644 --- a/cpp/doxygen/main_page.md +++ b/cpp/doxygen/main_page.md @@ -81,7 +81,7 @@ When KvikIO is running in compatibility mode, it doesn't load `libcufile.so`. In The environment variable `KVIKIO_COMPAT_MODE` has three options (case-insensitive): - `ON` (aliases: `TRUE`, `YES`, `1`): Enable the compatibility mode. - `OFF` (aliases: `FALSE`, `NO`, `0`): Disable the compatibility mode, and enforce cuFile I/O. GDS will be activated if the system requirements for cuFile are met and cuFile is properly configured. However, if the system is not suited for cuFile, I/O operations under the `OFF` option may error out, crash or hang. - - `AUTO` (default; alias: `WHATEVER`): Try cuFile I/O first, and fall back to POSIX I/O if the system requirements for cuFile are not met. + - `AUTO`: Try cuFile I/O first, and fall back to POSIX I/O if the system requirements for cuFile are not met. Under `AUTO`, KvikIO falls back to the compatibility mode: - when `libcufile.so` cannot be found. diff --git a/cpp/include/kvikio/defaults.hpp b/cpp/include/kvikio/defaults.hpp index a1efa6bc27..ab80bd258e 100644 --- a/cpp/include/kvikio/defaults.hpp +++ b/cpp/include/kvikio/defaults.hpp @@ -52,7 +52,7 @@ namespace detail { * include: * - `ON` (alias: `TRUE`, `YES`, `1`) * - `OFF` (alias: `FALSE`, `NO`, `0`) - * - `AUTO` (alias: `WHATEVER`) + * - `AUTO` * @return A CompatMode enum. */ inline CompatMode parse_compat_mode_str(std::string_view compat_mode_str) @@ -67,7 +67,7 @@ inline CompatMode parse_compat_mode_str(std::string_view compat_mode_str) res = CompatMode::ON; } else if (tmp == "off" || tmp == "false" || tmp == "no" || tmp == "0") { res = CompatMode::OFF; - } else if (tmp == "auto" || tmp == "whatever") { + } else if (tmp == "auto") { res = CompatMode::AUTO; } else { throw std::invalid_argument("Unknown compatibility mode: " + std::string{tmp}); diff --git a/docs/source/runtime_settings.rst b/docs/source/runtime_settings.rst index 678ef899ec..be5508741e 100644 --- a/docs/source/runtime_settings.rst +++ b/docs/source/runtime_settings.rst @@ -9,7 +9,7 @@ The environment variable ``KVIKIO_COMPAT_MODE`` has three options (case-insensit * ``ON`` (aliases: ``TRUE``, ``YES``, ``1``): Enable the compatibility mode. * ``OFF`` (aliases: ``FALSE``, ``NO``, ``0``): Disable the compatibility mode, and enforce cuFile I/O. GDS will be activated if the system requirements for cuFile are met and cuFile is properly configured. However, if the system is not suited for cuFile, I/O operations under the ``OFF`` option may error out, crash or hang. - * ``AUTO`` (default; alias: ``WHATEVER``): Try cuFile I/O first, and fall back to POSIX I/O if the system requirements for cuFile are not met. + * ``AUTO``: Try cuFile I/O first, and fall back to POSIX I/O if the system requirements for cuFile are not met. Under ``AUTO``, KvikIO falls back to the compatibility mode: