From a1e7fca6d98ec2696a9791871dd070a3765dd8d1 Mon Sep 17 00:00:00 2001
From: Felix Weiglhofer <weiglhofer@fias.uni-frankfurt.de>
Date: Tue, 4 Jul 2023 11:17:40 +0000
Subject: [PATCH] TimingsFormat: Add docstrings.
---
algo/base/util/TimingsFormat.h | 12 ++++++++++++
algo/detectors/tof/TofReadoutConfig.cxx | 2 +-
2 files changed, 13 insertions(+), 1 deletion(-)
diff --git a/algo/base/util/TimingsFormat.h b/algo/base/util/TimingsFormat.h
index 9b8d5282c1..593c8cae3a 100644
--- a/algo/base/util/TimingsFormat.h
+++ b/algo/base/util/TimingsFormat.h
@@ -16,8 +16,20 @@ namespace xpu
namespace cbm::algo
{
+
+ /**
+ * @brief Print timings from top-level times and subtimers.
+ */
std::string MakeReport(std::string_view title, const xpu::timings& t, size_t align = 40);
+
+ /**
+ * @brief Print timings from subtimers.
+ */
std::string MakeReportSubtimers(std::string_view title, const xpu::timings& t, size_t align = 40);
+
+ /**
+ * @brief Only print the top-level times (Elapsed time, total kernel time, memcpy and memset times). Disregard subtimers and kernel times.
+ */
std::string MakeReportSummary(std::string_view, const xpu::timings& t, size_t align = 40);
} // namespace cbm::algo
diff --git a/algo/detectors/tof/TofReadoutConfig.cxx b/algo/detectors/tof/TofReadoutConfig.cxx
index 8026523eab..0682bc4252 100644
--- a/algo/detectors/tof/TofReadoutConfig.cxx
+++ b/algo/detectors/tof/TofReadoutConfig.cxx
@@ -172,7 +172,7 @@ namespace cbm::algo
break;
}
case -1: {
- LOG(warning) << " Found unused GBTX link at uCh = " << uCh;
+ L_(warning) << " Found unused GBTX link at uCh = " << uCh;
uCh += 160;
break;
}
--
GitLab