cmake: improve some comments
after:
5205bfe79e cmake: replace 'dummy' with 'stub'
Change-Id: I8869f7286745c6eefeb3e2e2c359e98d527eb2e6
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 41576bd..3b45e21 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -345,7 +345,7 @@
endif()
endforeach()
-# Generate C/C++ stub files containing the function usage_exit(). Users of the
+# Generate C/C++ files containing the function usage_exit(). Users of the
# aom_common_app_util library must define this function. This is a convenience
# to allow omission of the function from applications that might want to use
# other pieces of the util support without defining usage_exit().
diff --git a/aom_dsp/aom_dsp.cmake b/aom_dsp/aom_dsp.cmake
index d6ec71f..e366622 100644
--- a/aom_dsp/aom_dsp.cmake
+++ b/aom_dsp/aom_dsp.cmake
@@ -336,7 +336,7 @@
list(APPEND AOM_LIB_TARGETS aom_dsp)
# Not all generators support libraries consisting only of object files. Add a
- # stub source file to the aom_dsp target.
+ # source file to the aom_dsp target.
add_stub_source_file_to_target("aom_dsp" "c")
if(CONFIG_AV1_DECODER)
diff --git a/build/cmake/aom_install.cmake b/build/cmake/aom_install.cmake
index 57cfcf7..cd5951c 100644
--- a/build/cmake/aom_install.cmake
+++ b/build/cmake/aom_install.cmake
@@ -31,7 +31,7 @@
include("GNUInstallDirs")
set(AOM_PKG_CONFIG_FILE "${AOM_CONFIG_DIR}/aom.pc")
- # Create a stub library target for creating aom.pc.
+ # Create a library target for creating aom.pc.
create_stub_source_file(aom_pc c AOM_PKG_CONFIG_SOURCES)
add_library(aom_pc ${AOM_PKG_CONFIG_SOURCES})
diff --git a/build/cmake/aom_optimization.cmake b/build/cmake/aom_optimization.cmake
index ea6e333..7ffc0b8 100644
--- a/build/cmake/aom_optimization.cmake
+++ b/build/cmake/aom_optimization.cmake
@@ -127,9 +127,10 @@
# Adds library target named $lib_name for ASM files in variable named by
# $asm_sources. Builds an output directory path from $lib_name. Links $lib_name
-# into the aom library target(s). Generates a stub C file with a stub function
-# to ensure that all cmake generators can determine the linker language, and
-# that build tools don't complain that an object exposes no symbols.
+# into the aom library target(s). Generates a C file with an unused no-op
+# function to ensure that all cmake generators can determine the linker
+# language, and that build tools don't complain that an object exposes no
+# symbols.
#
# In shared library configs every step described above happens twice, and
# directory/target/object names are updated to include _shared and _static
@@ -173,10 +174,10 @@
endforeach()
# The above created a target containing only ASM sources. CMake needs help
- # here to determine the linker language. Add a stub C file to force the
- # linker language to C. We don't bother with setting the LINKER_LANGUAGE
- # property on the library target because not all generators obey it (looking
- # at you, Xcode generator).
+ # here to determine the linker language. Add a C file with an unused no-op
+ # function to force the linker language to C. We don't bother with setting
+ # the LINKER_LANGUAGE property on the library target because not all
+ # generators obey it (looking at you, Xcode generator).
add_stub_source_file_to_target("${asm_lib_name}" "c")
# Add the new lib target to the global list of aom library targets.
diff --git a/build/cmake/util.cmake b/build/cmake/util.cmake
index ddc6fcf..2033dd3 100644
--- a/build/cmake/util.cmake
+++ b/build/cmake/util.cmake
@@ -16,9 +16,9 @@
# Directory where generated sources will be written.
set(AOM_GEN_SRC_DIR "${AOM_CONFIG_DIR}/gen_src")
-# Creates stub source file in $AOM_GEN_SRC_DIR named $basename.$extension and
-# returns the full path to the stub source file via appending it to the list
-# variable referred to by $out_file_list_var parameter.
+# Creates source file in $AOM_GEN_SRC_DIR named $basename.$extension and returns
+# the full path to the source file via appending it to the list variable
+# referred to by $out_file_list_var parameter.
macro(create_stub_source_file basename extension out_file_list_var)
set(stub_source_file "${AOM_GEN_SRC_DIR}/${basename}_stub.${extension}")
file(WRITE "${stub_source_file}"
