mirror of
https://github.com/Kitware/CMake.git
synced 2026-04-24 07:08:38 -05:00
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
This commit is contained in:
+73
-35
@@ -1,58 +1,96 @@
|
||||
#.rst:
|
||||
# FindGTest
|
||||
# ---------
|
||||
#
|
||||
# --------------------
|
||||
#
|
||||
# Locate the Google C++ Testing Framework.
|
||||
#
|
||||
# Defines the following variables:
|
||||
#
|
||||
# GTEST_FOUND - Found the Google Testing framework
|
||||
# GTEST_INCLUDE_DIRS - Include directories
|
||||
# ::
|
||||
#
|
||||
# GTEST_FOUND - Found the Google Testing framework
|
||||
# GTEST_INCLUDE_DIRS - Include directories
|
||||
#
|
||||
#
|
||||
#
|
||||
# Also defines the library variables below as normal variables. These
|
||||
# contain debug/optimized keywords when a debugging library is found.
|
||||
#
|
||||
# ::
|
||||
#
|
||||
# GTEST_BOTH_LIBRARIES - Both libgtest & libgtest-main
|
||||
# GTEST_LIBRARIES - libgtest
|
||||
# GTEST_MAIN_LIBRARIES - libgtest-main
|
||||
#
|
||||
# Also defines the library variables below as normal
|
||||
# variables. These contain debug/optimized keywords when
|
||||
# a debugging library is found.
|
||||
#
|
||||
# GTEST_BOTH_LIBRARIES - Both libgtest & libgtest-main
|
||||
# GTEST_LIBRARIES - libgtest
|
||||
# GTEST_MAIN_LIBRARIES - libgtest-main
|
||||
#
|
||||
# Accepts the following variables as input:
|
||||
#
|
||||
# GTEST_ROOT - (as a CMake or environment variable)
|
||||
# The root directory of the gtest install prefix
|
||||
# ::
|
||||
#
|
||||
# GTEST_ROOT - (as a CMake or environment variable)
|
||||
# The root directory of the gtest install prefix
|
||||
#
|
||||
#
|
||||
#
|
||||
# ::
|
||||
#
|
||||
# GTEST_MSVC_SEARCH - If compiling with MSVC, this variable can be set to
|
||||
# "MD" or "MT" to enable searching a GTest build tree
|
||||
# (defaults: "MD")
|
||||
#
|
||||
#
|
||||
# GTEST_MSVC_SEARCH - If compiling with MSVC, this variable can be set to
|
||||
# "MD" or "MT" to enable searching a GTest build tree
|
||||
# (defaults: "MD")
|
||||
#
|
||||
#-----------------------
|
||||
# Example Usage:
|
||||
#
|
||||
# enable_testing()
|
||||
# find_package(GTest REQUIRED)
|
||||
# include_directories(${GTEST_INCLUDE_DIRS})
|
||||
# ::
|
||||
#
|
||||
# add_executable(foo foo.cc)
|
||||
# target_link_libraries(foo ${GTEST_BOTH_LIBRARIES})
|
||||
# enable_testing()
|
||||
# find_package(GTest REQUIRED)
|
||||
# include_directories(${GTEST_INCLUDE_DIRS})
|
||||
#
|
||||
# add_test(AllTestsInFoo foo)
|
||||
#
|
||||
#-----------------------
|
||||
#
|
||||
# If you would like each Google test to show up in CTest as
|
||||
# a test you may use the following macro.
|
||||
# NOTE: It will slow down your tests by running an executable
|
||||
# for each test and test fixture. You will also have to rerun
|
||||
# CMake after adding or removing tests or test fixtures.
|
||||
# ::
|
||||
#
|
||||
# add_executable(foo foo.cc)
|
||||
# target_link_libraries(foo ${GTEST_BOTH_LIBRARIES})
|
||||
#
|
||||
#
|
||||
#
|
||||
# ::
|
||||
#
|
||||
# add_test(AllTestsInFoo foo)
|
||||
#
|
||||
#
|
||||
#
|
||||
#
|
||||
#
|
||||
# If you would like each Google test to show up in CTest as a test you
|
||||
# may use the following macro. NOTE: It will slow down your tests by
|
||||
# running an executable for each test and test fixture. You will also
|
||||
# have to rerun CMake after adding or removing tests or test fixtures.
|
||||
#
|
||||
# GTEST_ADD_TESTS(executable extra_args ARGN)
|
||||
# executable = The path to the test executable
|
||||
# extra_args = Pass a list of extra arguments to be passed to
|
||||
# executable enclosed in quotes (or "" for none)
|
||||
# ARGN = A list of source files to search for tests & test
|
||||
# fixtures.
|
||||
#
|
||||
# Example:
|
||||
# set(FooTestArgs --foo 1 --bar 2)
|
||||
# add_executable(FooTest FooUnitTest.cc)
|
||||
# GTEST_ADD_TESTS(FooTest "${FooTestArgs}" FooUnitTest.cc)
|
||||
# ::
|
||||
#
|
||||
# executable = The path to the test executable
|
||||
# extra_args = Pass a list of extra arguments to be passed to
|
||||
# executable enclosed in quotes (or "" for none)
|
||||
# ARGN = A list of source files to search for tests & test
|
||||
# fixtures.
|
||||
#
|
||||
#
|
||||
#
|
||||
# ::
|
||||
#
|
||||
# Example:
|
||||
# set(FooTestArgs --foo 1 --bar 2)
|
||||
# add_executable(FooTest FooUnitTest.cc)
|
||||
# GTEST_ADD_TESTS(FooTest "${FooTestArgs}" FooUnitTest.cc)
|
||||
|
||||
#=============================================================================
|
||||
# Copyright 2009 Kitware, Inc.
|
||||
|
||||
Reference in New Issue
Block a user