Add the third option to configure the CMake option

otegami · Dec 11, 2024 · 0b01b3f · 0b01b3f
1 parent ff87330
commit 0b01b3f
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/include/groonga/groonga.h b/include/groonga/groonga.h
@@ -612,10 +612,10 @@ grn_get_lock_timeout(void);
  * **Lock Timeout Configuration**:
  *
  * Lock timeout can be configured in two ways:
- * - **Environment Variable**: Set `GRN_LOCK_TIMEOUT` before running the program
- *   to specify a default lock timeout by milliseconds.
- * - **API**: Use \ref grn_set_lock_timeout to override the environment variable
- *   setting at runtime.
+ * - **CMake Option**: Use `-DGRN_LOCK_TIMEOUT=<milliseconds>` when configuring
+ *   the build with CMake to specify a default lock timeout by milliseconds.
+ * - **API**: Use \ref grn_set_lock_timeout to override the default setting at
+ *   runtime.
  *
  * \param timeout The new lock timeout in milliseconds.
  *