summaryrefslogtreecommitdiffstats
path: root/Modules/FindBacktrace.cmake
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2014-10-22 19:52:31 (GMT)
committerBrad King <brad.king@kitware.com>2014-10-22 19:52:31 (GMT)
commit58b2d760ee094e6f1a4a8701f86efcb81977b047 (patch)
tree2cf1d02b16f8519155779e052dd21639894fb226 /Modules/FindBacktrace.cmake
parent54ff77dc621a91302abad0ab38d9bd26de8914b9 (diff)
downloadCMake-58b2d760ee094e6f1a4a8701f86efcb81977b047.zip
CMake-58b2d760ee094e6f1a4a8701f86efcb81977b047.tar.gz
CMake-58b2d760ee094e6f1a4a8701f86efcb81977b047.tar.bz2
Modules: Format documentation to avoid over-long preformatted lines
Convert several preformatted code block literals that enumerate lists of options or variables to use reST definition lists instead. Manually wrap other long lines in code blocks.
Diffstat (limited to 'Modules/FindBacktrace.cmake')
-rw-r--r--Modules/FindBacktrace.cmake24
1 files changed, 15 insertions, 9 deletions
diff --git a/Modules/FindBacktrace.cmake b/Modules/FindBacktrace.cmake
index 07109b0..cb4f60a 100644
--- a/Modules/FindBacktrace.cmake
+++ b/Modules/FindBacktrace.cmake
@@ -5,18 +5,24 @@
# Find provider for backtrace(3).
#
# Checks if OS supports backtrace(3) via either libc or custom library.
-# This module defines the following variables::
+# This module defines the following variables:
#
-# Backtrace_HEADER - 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.
-# Backtrace_LIBRARIES - The libraries (linker flags) needed to use backtrace(3), if any.
-# Backtrace_FOUND - Is set if and only if backtrace(3) support detected.
+# ``Backtrace_HEADER``
+# 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.
+# ``Backtrace_LIBRARIES``
+# The libraries (linker flags) needed to use backtrace(3), if any.
+# ``Backtrace_FOUND``
+# Is set if and only if backtrace(3) support detected.
#
-# The following cache variables are also available to set or use::
+# 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.
+# ``Backtrace_LIBRARY``
+# The external library providing backtrace, if any.
+# ``Backtrace_INCLUDE_DIR``
+# The directory holding the backtrace(3) header.
#
# Typical usage is to generate of header file using configure_file() with the
# contents like the following::