cmake: document CMakeLists.txt hierarchy

ethomson · ethomson · commit 5fcfada50007 · 2022-02-22T22:07:44.000-05:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,5 +1,8 @@
-# CMake build script for the libgit2 project
+# libgit2: the cross-platform, linkable library implementation of git.
 # See `README.md` for build instructions.
+#
+# This top-level CMakeLists.txt sets up configuration options and
+# determines which subprojects to build.
 
 cmake_minimum_required(VERSION 3.5.1)
 
diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
@@ -1,3 +1,5 @@
+# examples: code usage examples of libgit2
+
 file(GLOB SRC_EXAMPLES *.c *.h)
 
 add_executable(lg2 ${SRC_EXAMPLES})
diff --git a/fuzzers/CMakeLists.txt b/fuzzers/CMakeLists.txt
@@ -1,3 +1,5 @@
+# fuzzers: libFuzzer and standalone fuzzing utilities
+
 if(BUILD_FUZZERS AND NOT USE_STANDALONE_FUZZERS)
 	set(CMAKE_REQUIRED_FLAGS "-fsanitize=fuzzer-no-link")
 	add_c_flag(-fsanitize=fuzzer)
diff --git a/src/libgit2/CMakeLists.txt b/src/libgit2/CMakeLists.txt
@@ -1,3 +1,6 @@
+# libgit2: the shared library: this CMakeLists.txt compiles the core
+# git library functionality.
+
 add_library(git2internal OBJECT)
 set_target_properties(git2internal PROPERTIES C_STANDARD 90)
 set_target_properties(git2internal PROPERTIES C_EXTENSIONS OFF)
diff --git a/src/util/CMakeLists.txt b/src/util/CMakeLists.txt
@@ -54,6 +54,7 @@ list(SORT UTIL_SRC_HASH)
 #
 
 target_sources(util PRIVATE ${UTIL_SRC} ${UTIL_SRC_OS} ${UTIL_SRC_HASH})
+ide_split_sources(util)
 
 target_include_directories(util PRIVATE ${UTIL_INCLUDES} ${LIBGIT2_DEPENDENCY_INCLUDES} PUBLIC ${libgit2_SOURCE_DIR}/include)
 target_include_directories(util SYSTEM PRIVATE ${LIBGIT2_SYSTEM_INCLUDES})
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -1,3 +1,5 @@
+# tests: the unit and integration tests for libgit2
+
 set(Python_ADDITIONAL_VERSIONS 3 2.7)
 find_package(PythonInterp)
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# examples: code usage examples of libgit2`
	`2`	`+`
`1`	`3`	`file(GLOB SRC_EXAMPLES .c .h)`
`2`	`4`
`3`	`5`	`add_executable(lg2 ${SRC_EXAMPLES})`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# fuzzers: libFuzzer and standalone fuzzing utilities`
	`2`	`+`
`1`	`3`	`if(BUILD_FUZZERS AND NOT USE_STANDALONE_FUZZERS)`
`2`	`4`	`set(CMAKE_REQUIRED_FLAGS "-fsanitize=fuzzer-no-link")`
`3`	`5`	`add_c_flag(-fsanitize=fuzzer)`
Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,7 @@ list(SORT UTIL_SRC_HASH)`
`54`	`54`	`#`
`55`	`55`
`56`	`56`	`target_sources(util PRIVATE ${UTIL_SRC} ${UTIL_SRC_OS} ${UTIL_SRC_HASH})`
	`57`	`+ide_split_sources(util)`
`57`	`58`
`58`	`59`	`target_include_directories(util PRIVATE ${UTIL_INCLUDES} ${LIBGIT2_DEPENDENCY_INCLUDES} PUBLIC ${libgit2_SOURCE_DIR}/include)`
`59`	`60`	`target_include_directories(util SYSTEM PRIVATE ${LIBGIT2_SYSTEM_INCLUDES})`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# tests: the unit and integration tests for libgit2`
	`2`	`+`
`1`	`3`	`set(Python_ADDITIONAL_VERSIONS 3 2.7)`
`2`	`4`	`find_package(PythonInterp)`
`3`	`5`