Update usage example for dependency tracking

sean-parent · sean-parent · commit a1cb53661dfd · 2025-12-16T14:29:38.000-08:00
Revises the usage instructions in cpp-library-dependency-provider.cmake to recommend calling cpp_library_enable_dependency_tracking() before project(), instead of modifying CMAKE_PROJECT_TOP_LEVEL_INCLUDES.
diff --git a/cmake/cpp-library-dependency-provider.cmake b/cmake/cpp-library-dependency-provider.cmake
@@ -11,10 +11,10 @@
 #   cmake_minimum_required(VERSION 3.24)
 #   include(cmake/CPM.cmake)
 #   CPMAddPackage("gh:stlab/cpp-library@X.Y.Z")
+#   include(${cpp-library_SOURCE_DIR}/cpp-library.cmake)
 #   
-#   # Enable dependency tracking
-#   list(APPEND CMAKE_PROJECT_TOP_LEVEL_INCLUDES 
-#       "${cpp-library_SOURCE_DIR}/cmake/cpp-library-dependency-provider.cmake")
+#   # Enable dependency tracking BEFORE project()
+#   cpp_library_enable_dependency_tracking()
 #   
 #   project(my-library)  # Provider is installed here
 #   

Original file line number	Diff line number	Diff line change
`@@ -11,10 +11,10 @@`
`11`	`11`	`# cmake_minimum_required(VERSION 3.24)`
`12`	`12`	`# include(cmake/CPM.cmake)`
`13`	`13`	`# CPMAddPackage("gh:stlab/cpp-library@X.Y.Z")`
	`14`	`+# include(${cpp-library_SOURCE_DIR}/cpp-library.cmake)`
`14`	`15`	`#`
`15`		`-# # Enable dependency tracking`
`16`		`-# list(APPEND CMAKE_PROJECT_TOP_LEVEL_INCLUDES`
`17`		`-# "${cpp-library_SOURCE_DIR}/cmake/cpp-library-dependency-provider.cmake")`
	`16`	`+# # Enable dependency tracking BEFORE project()`
	`17`	`+# cpp_library_enable_dependency_tracking()`
`18`	`18`	`#`
`19`	`19`	`# project(my-library) # Provider is installed here`
`20`	`20`	`#`