Add the third option to configure the CMake option

otegami · Dec 11, 2024 · 0431939 · 0431939
1 parent ff87330
commit 0431939
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/include/groonga/groonga.h b/include/groonga/groonga.h
@@ -612,6 +612,8 @@ grn_get_lock_timeout(void);
  * **Lock Timeout Configuration**:
  *
  * Lock timeout can be configured in two ways:
+ * - **CMake Option**: Use `-DGRN_LOCK_TIMEOUT=<milliseconds>` when configuring
+ *   the build with CMake to specify a default lock timeout by milliseconds.
  * - **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