summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2022-03-13 09:31:08 (GMT)
committerCraig Scott <craig.scott@crascit.com>2022-03-13 09:31:08 (GMT)
commit95cdce829f7c0ac3dbacb80c69004aea6a3d4d35 (patch)
treeb895107c08e0230d5c2b2a967e59d42b1e348ce7
parent736e80dbcafc4c46950688b915e0688f1b817862 (diff)
downloadCMake-95cdce829f7c0ac3dbacb80c69004aea6a3d4d35.zip
CMake-95cdce829f7c0ac3dbacb80c69004aea6a3d4d35.tar.gz
CMake-95cdce829f7c0ac3dbacb80c69004aea6a3d4d35.tar.bz2
Help: Fix typo and improve readability for LINK_LIBRARIES_ONLY_TARGETS
-rw-r--r--Help/prop_tgt/LINK_LIBRARIES_ONLY_TARGETS.rst7
1 files changed, 3 insertions, 4 deletions
diff --git a/Help/prop_tgt/LINK_LIBRARIES_ONLY_TARGETS.rst b/Help/prop_tgt/LINK_LIBRARIES_ONLY_TARGETS.rst
index 78fbb02..a9af74d 100644
--- a/Help/prop_tgt/LINK_LIBRARIES_ONLY_TARGETS.rst
+++ b/Help/prop_tgt/LINK_LIBRARIES_ONLY_TARGETS.rst
@@ -20,17 +20,16 @@ This property is initialized by the value of the
target is created. The property may be explicitly enabled on an imported
target to check its link interface.
-For example, the following code:
+In the following example, CMake will halt with an error at configure time
+because ``miLib`` is not a target:
.. code-block:: cmake
set(CMAKE_LINK_LIBRARIES_ONLY_TARGETS ON)
- add_executable(myLib STATIC myLib.c)
+ add_library(myLib STATIC myLib.c)
add_executable(myExe myExe.c)
target_link_libraries(myExe PRIVATE miLib) # typo for myLib
-will produce a CMake-time error that ``miLib`` is not a target.
-
In order to link toolchain-provided libraries by name while still
enforcing ``LINK_LIBRARIES_ONLY_TARGETS``, use an
:ref:`imported <Imported Targets>`