Skip to content

Commit 61787d6

Browse files
committed
Add more doc for avaialbe options for USE_LIBBACKTRACE
1 parent 1f08062 commit 61787d6

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

cmake/modules/Logging.cmake

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,14 @@ macro(__compile_libbacktrace)
6868
set(LIBBACKTRACE_FOUND YES)
6969
endmacro()
7070

71-
71+
# Available options for USE_LIBBACKTRACE:
72+
# - OFF: Don't use libbacktrace
73+
# - ON: Find libbacktrace from system paths. Fail the build generation if libbacktrace is not found.
74+
# - COMPILE: Build and link to libbacktrace from 3rdparty/libbacktrace.
75+
# - <PATH>: Looking for the libbacktrace header and static lib from a user-provided path. Fail the build generation if libbacktrace is not found.
76+
# - AUTO:
77+
# - Find libbacktrace from system paths.
78+
# - If not found, fallback to COMPILE on Linux or MacOS, fallback to OFF on Windows.
7279
if(USE_LIBBACKTRACE STREQUAL "AUTO")
7380
__find_libbacktrace()
7481
if(NOT LIBBACKTRACE_FOUND AND (CMAKE_SYSTEM_NAME MATCHES "Linux" OR CMAKE_SYSTEM_NAME MATCHES "Darwin"))

0 commit comments

Comments
 (0)