Add reference documentation for tribits_trace_file_processing() (TriB…

…ITSPub#63, TriBITSPub#299, TriBITSPub#494)
bartlettroscoe · Jul 14, 2022 · 9f9a81a · 9f9a81a
1 parent 270dee8
commit 9f9a81a
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/tribits/core/package_arch/TribitsGeneralMacros.cmake b/tribits/core/package_arch/TribitsGeneralMacros.cmake
@@ -373,7 +373,23 @@ function( tribits_gather_enabled_items  PACKAGE_NAME  LISTTYPE_PREFIX
 endfunction()
 
 
-# Print trace of file processing
+# @FUNCTION: tribits_trace_file_processing()
+#
+# Print trace of file processing when
+# ``${PROJECT_NAME}_TRACE_FILE_PROCESSING`` is ``TRUE``.
+#
+# Usage::
+#
+#   tribits_trace_file_processing( <type> <processingType> <filePath>)
+#
+# Arguments:
+#
+# * ``<type>``: Allowed values "PROJECT", "REPOSITORY", "PACKAGE", or "TPL"
+#
+# * ``<processingType>``: Allowed values "INCLUDE", "ADD_SUBDIR", "READ", or
+#   "CONFIGURE"
+#
+# * ``<filePath>``: Path of the file being processed
 #
 function(tribits_trace_file_processing  TYPE_IN  PROCESSING_TYPE_IN  FILE_PATH)
 
@@ -410,5 +426,3 @@ function(tribits_trace_file_processing  TYPE_IN  PROCESSING_TYPE_IN  FILE_PATH)
   endif()
 
 endfunction()
-
-
diff --git a/tribits/doc/guides/TribitsSystemMacroFunctionDocTemplate.rst b/tribits/doc/guides/TribitsSystemMacroFunctionDocTemplate.rst
@@ -42,6 +42,7 @@ understand the internals of TriBITS.
 @MACRO:    tribits_read_deps_files_create_deps_graph() +
 @MACRO:    tribits_save_off_dependency_vars() +
 @FUNCTION: tribits_set_dep_packages() +
+@FUNCTION: tribits_trace_file_processing() +
 @FUNCTION: tribits_write_package_client_export_files_install_targets() +
 @MACRO:    tribits_write_xml_dependency_files() +
 @FUNCTION: tribits_write_xml_dependency_files_if_supported() +