gobhardw/docs logging (#10)

* reducing docs logging * Addressing review comments * exclude dirs * maximize NUM_PROC_THREADS * parallel build
ROCm · Dec 10, 2024 · 3ee06ed · 3ee06ed
1 parent 253c9ad
commit 3ee06ed
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 7 deletions.
diff --git a/source/docs/CMakeLists.txt b/source/docs/CMakeLists.txt
@@ -59,6 +59,13 @@ function(DOCS_EXECUTE_PROCESS)
     endif()
 endfunction()
 
+include(ProcessorCount)
+processorcount(ROCP_NUM_PROCS)
+if(NOT ROCP_NUM_PROCS EQUAL 0)
+    set(DOCS_BUILD_JOBS -j${ROCP_NUM_PROCS})
+    message(STATUS "Using ${ROCP_NUM_PROCS} jobs for docs build")
+endif()
+
 file(
     WRITE "${CMAKE_CURRENT_BINARY_DIR}/build-docs.sh"
     "#!${SHELL_CMD}
@@ -112,7 +119,7 @@ doxygen rocprofiler-sdk.dox
 
 doxysphinx build \${WORK_DIR} \${WORK_DIR}/_build/html \${WORK_DIR}/_doxygen/html
 
-make html SPHINXOPTS=\"-W --keep-going -n\"
+make html SPHINXOPTS=\"-W --keep-going ${DOCS_BUILD_JOBS} -n\"
 
 rm -rf ${PROJECT_SOURCE_DIR}/build-docs
 ")

diff --git a/source/docs/rocprofiler-sdk.dox.in b/source/docs/rocprofiler-sdk.dox.in
@@ -108,7 +108,7 @@ CITE_BIB_FILES         =
 #---------------------------------------------------------------------------
 # Configuration options related to warning and progress messages
 #---------------------------------------------------------------------------
-QUIET                  = NO
+QUIET                  = YES
 WARNINGS               = YES
 WARN_IF_UNDOCUMENTED   = YES
 WARN_IF_DOC_ERROR      = YES
@@ -145,7 +145,11 @@ EXCLUDE_SYMLINKS       = YES
 EXCLUDE_PATTERNS       = */.git/* \
                          @SOURCE_DIR@/**/tests/* \
                          @SOURCE_DIR@/**/scripts/* \
-                         @SOURCE_DIR@/**/docs/*
+                         @SOURCE_DIR@/**/docs/* \
+                         @SOURCE_DIR@/**/cmake/* \
+                         @SOURCE_DIR@/**/external/* \
+                         @SOURCE_DIR@/**/RPM/* \
+                         @SOURCE_DIR@/**/ISSUE_TEMPLATE/*
 EXCLUDE_SYMBOLS        = "std::*" \
                          "ROCPROFILER_ATTRIBUTE" \
                          "ROCPROFILER_API" \
@@ -395,7 +399,7 @@ DIAFILE_DIRS           =
 PLANTUML_JAR_PATH      =
 PLANTUML_CFG_FILE      =
 PLANTUML_INCLUDE_PATH  =
-DOT_GRAPH_MAX_NODES    = 50
+DOT_GRAPH_MAX_NODES    = 100
 MAX_DOT_GRAPH_DEPTH    = 0
 DOT_MULTI_TARGETS      = YES
 GENERATE_LEGEND        = YES

diff --git a/source/include/rocprofiler-sdk/amd_detail/thread_trace_core.h b/source/include/rocprofiler-sdk/amd_detail/thread_trace_core.h
@@ -66,8 +66,7 @@ typedef struct
  * @param [in] shader_engine_id ID of shader engine, as enabled by SE_MASK
  * @param [in] data Pointer to the buffer containing the ATT data
  * @param [in] data_size Number of bytes in "data"
- * @param [in] userdata_dispatch Passed back to user from rocprofiler_att_dispatch_callback_t()
- * @param [in] userdata_config Passed back to user from configure_[...]_service()
+ * @param [in] userdata Passed back to user from rocprofiler_att_dispatch_callback_t()
  */
 typedef void (*rocprofiler_att_shader_data_callback_t)(int64_t                 shader_engine_id,
                                                        void*                   data,

diff --git a/source/include/rocprofiler-sdk/fwd.h b/source/include/rocprofiler-sdk/fwd.h
@@ -169,7 +169,7 @@ typedef enum  // NOLINT(performance-enum-size)
     ROCPROFILER_CALLBACK_TRACING_SCRATCH_MEMORY,  ///< @see ::rocprofiler_scratch_memory_operation_t
     ROCPROFILER_CALLBACK_TRACING_KERNEL_DISPATCH,    ///< Callbacks for kernel dispatches
     ROCPROFILER_CALLBACK_TRACING_MEMORY_COPY,        ///< @see ::rocprofiler_memory_copy_operation_t
-    ROCPROFILER_CALLBACK_TRACING_RCCL_API,           ///< @RCCL tracing
+    ROCPROFILER_CALLBACK_TRACING_RCCL_API,           ///< RCCL tracing
     ROCPROFILER_CALLBACK_TRACING_OMPT,               ///< @see ::rocprofiler_ompt_operation_t
     ROCPROFILER_CALLBACK_TRACING_MEMORY_ALLOCATION,  ///< @see
                                                      ///< ::rocprofiler_memory_allocation_operation_t