diff options
| author | Bartosz Kosiorek <bartosz.kosiorek@tomtom.com> | 2019-04-12 14:37:05 (GMT) |
|---|---|---|
| committer | Bartosz Kosiorek <bartosz.kosiorek@tomtom.com> | 2019-04-23 08:39:34 (GMT) |
| commit | cb811d11cee1e2873cc2bf506cd081769e894ac3 (patch) | |
| tree | 6fa97b0fb931bfbc6faaf866c3e745a0fd5ea430 /Modules/FindBacktrace.cmake | |
| parent | 4ff7706f2d7eaaffe3970da5f77d18f67771a4a8 (diff) | |
| download | CMake-cb811d11cee1e2873cc2bf506cd081769e894ac3.zip CMake-cb811d11cee1e2873cc2bf506cd081769e894ac3.tar.gz CMake-cb811d11cee1e2873cc2bf506cd081769e894ac3.tar.bz2 | |
Help: Improve description of modules
Diffstat (limited to 'Modules/FindBacktrace.cmake')
| -rw-r--r-- | Modules/FindBacktrace.cmake | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/Modules/FindBacktrace.cmake b/Modules/FindBacktrace.cmake index e1f45f7..cf1632a 100644 --- a/Modules/FindBacktrace.cmake +++ b/Modules/FindBacktrace.cmake @@ -5,30 +5,30 @@ FindBacktrace ------------- -Find provider for backtrace(3). +Find provider for `backtrace(3) <http://man7.org/linux/man-pages/man3/backtrace.3.html>`__. -Checks if OS supports backtrace(3) via either libc or custom library. +Checks if OS supports ``backtrace(3)`` via either ``libc`` or custom library. This module defines the following variables: ``Backtrace_HEADER`` - The header file needed for backtrace(3). Cached. + The header file needed for ``backtrace(3)``. Cached. Could be forcibly set by user. ``Backtrace_INCLUDE_DIRS`` - The include directories needed to use backtrace(3) header. + The include directories needed to use ``backtrace(3)`` header. ``Backtrace_LIBRARIES`` - The libraries (linker flags) needed to use backtrace(3), if any. + The libraries (linker flags) needed to use ``backtrace(3)``, if any. ``Backtrace_FOUND`` - Is set if and only if backtrace(3) support detected. + Is set if and only if ``backtrace(3)`` support detected. The following cache variables are also available to set or use: ``Backtrace_LIBRARY`` The external library providing backtrace, if any. ``Backtrace_INCLUDE_DIR`` - The directory holding the backtrace(3) header. + The directory holding the ``backtrace(3)`` header. -Typical usage is to generate of header file using configure_file() with the -contents like the following:: +Typical usage is to generate of header file using :command:`configure_file` +with the contents like the following:: #cmakedefine01 Backtrace_FOUND #if Backtrace_FOUND |