[llvm] f7062f6 - [docs] Improve description of LLVM_BUILD_TESTS

Keith Smiley via llvm-commits llvm-commits at lists.llvm.org
Fri Sep 10 18:01:56 PDT 2021


Author: Keith Smiley
Date: 2021-09-10T18:01:38-07:00
New Revision: f7062f6dfbbcc3ac13c215a620bbbe3806fa2c77

URL: https://github.com/llvm/llvm-project/commit/f7062f6dfbbcc3ac13c215a620bbbe3806fa2c77
DIFF: https://github.com/llvm/llvm-project/commit/f7062f6dfbbcc3ac13c215a620bbbe3806fa2c77.diff

LOG: [docs] Improve description of LLVM_BUILD_TESTS

This makes it clear that this only has an effect if you use the all
build target.

Differential Revision: https://reviews.llvm.org/D109113

Added: 
    

Modified: 
    llvm/docs/CMake.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/CMake.rst b/llvm/docs/CMake.rst
index 55a174259066f..ef62a1189fedc 100644
--- a/llvm/docs/CMake.rst
+++ b/llvm/docs/CMake.rst
@@ -339,12 +339,12 @@ enabled sub-projects. Nearly all of these variable names begin with
   This option is not available on Windows.
 
 **LLVM_BUILD_TESTS**:BOOL
-  Build LLVM unit tests. Defaults to OFF. Targets for building each unit test
-  are generated in any case. You can build a specific unit test using the
-  targets defined under *unittests*, such as ADTTests, IRTests, SupportTests,
-  etc. (Search for ``add_llvm_unittest`` in the subdirectories of *unittests*
-  for a complete list of unit tests.) It is possible to build all unit tests
-  with the target *UnitTests*.
+  Include LLVM unit tests in the 'all' build target. Defaults to OFF. Targets
+  for building each unit test are generated in any case. You can build a
+  specific unit test using the targets defined under *unittests*, such as
+  ADTTests, IRTests, SupportTests, etc. (Search for ``add_llvm_unittest`` in
+  the subdirectories of *unittests* for a complete list of unit tests.) It is
+  possible to build all unit tests with the target *UnitTests*.
 
 **LLVM_BUILD_TOOLS**:BOOL
   Build LLVM tools. Defaults to ON. Targets for building each tool are generated


        


More information about the llvm-commits mailing list