[SYCLomatic] Add extra comment for helper function calculate_max_active_wg_per_xecore() (#921)

zhiweij1 · web-flow · commit 50613794235e · 2023-05-22T16:34:15.000+08:00
Signed-off-by: Jiang, Zhiwei &lt;zhiwei.jiang@intel.com&gt;
diff --git a/clang/runtime/dpct-rt/include/util.hpp.inc b/clang/runtime/dpct-rt/include/util.hpp.inc
@@ -823,7 +823,8 @@ public:
 // Device|get_current_device
 // DPCT_DEPENDENCY_END
 // DPCT_CODE
-/// Computes the max active work-group number per Xe-Core. Ref to
+/// This function is used for occupancy calculation, it computes the max active
+/// work-group number per Xe-Core. Ref to
 /// https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/GPU-Occupancy-Calculator
 /// \param [out] num_wg Active work-group number.
 /// \param [in] wg_size Work-group size.
diff --git a/clang/test/dpct/helper_files_ref/include/util.hpp b/clang/test/dpct/helper_files_ref/include/util.hpp
@@ -625,7 +625,8 @@ class logical_group {
   }
 };
 
-/// Computes the max active work-group number per Xe-Core. Ref to
+/// This function is used for occupancy calculation, it computes the max active
+/// work-group number per Xe-Core. Ref to
 /// https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/GPU-Occupancy-Calculator
 /// \param [out] num_wg Active work-group number.
 /// \param [in] wg_size Work-group size.

Original file line number	Diff line number	Diff line change
`@@ -625,7 +625,8 @@ class logical_group {`
`625`	`625`	`}`
`626`	`626`	`};`
`627`	`627`
`628`		`-/// Computes the max active work-group number per Xe-Core. Ref to`
	`628`	`+/// This function is used for occupancy calculation, it computes the max active`
	`629`	`+/// work-group number per Xe-Core. Ref to`
`629`	`630`	`/// https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/GPU-Occupancy-Calculator`
`630`	`631`	`/// \param [out] num_wg Active work-group number.`
`631`	`632`	`/// \param [in] wg_size Work-group size.`