|
|
@@ -163,12 +163,14 @@ endfunction()
|
|
|
|
|
|
# idf_build_component
|
|
|
#
|
|
|
-# @brief Specify component directory for the build system to process.
|
|
|
+# @brief Present a directory that contains a component to the build system.
|
|
|
# Relative paths are converted to absolute paths with respect to current directory.
|
|
|
-# Any component that needs to be processed has to be specified using this
|
|
|
-# command before calling idf_build_process.
|
|
|
+# All calls to this command must be performed before idf_build_process.
|
|
|
#
|
|
|
-# @param[in] component_dir directory of the component to process
|
|
|
+# @note This command does not guarantee that the component will be processed
|
|
|
+# during build (see the COMPONENTS argument description for command idf_build_process)
|
|
|
+#
|
|
|
+# @param[in] component_dir directory of the component
|
|
|
function(idf_build_component component_dir)
|
|
|
idf_build_get_property(prefix __PREFIX)
|
|
|
__component_add(${component_dir} ${prefix} 0)
|
|
|
@@ -335,7 +337,16 @@ endfunction()
|
|
|
# @param[in, optional] SDKCONFIG_DEFAULTS (single value) config defaults file to use for the build; defaults
|
|
|
# to none (Kconfig defaults or previously generated config are used)
|
|
|
# @param[in, optional] BUILD_DIR (single value) directory for build artifacts; defautls to CMAKE_BINARY_DIR
|
|
|
-# @param[in, optional] COMPONENTS (multivalue) starting components for trimming build
|
|
|
+# @param[in, optional] COMPONENTS (multivalue) select components to process among the components
|
|
|
+# known by the build system
|
|
|
+# (added via `idf_build_component`). This argument is used to trim the build.
|
|
|
+# Other components are automatically added if they are required
|
|
|
+# in the dependency chain, i.e.
|
|
|
+# the public and private requirements of the components in this list
|
|
|
+# are automatically added, and in
|
|
|
+# turn the public and private requirements of those requirements,
|
|
|
+# so on and so forth. If not specified, all components known to the build system
|
|
|
+# are processed.
|
|
|
macro(idf_build_process target)
|
|
|
set(options)
|
|
|
set(single_value PROJECT_DIR PROJECT_VER PROJECT_NAME BUILD_DIR SDKCONFIG SDKCONFIG_DEFAULTS)
|