Browse Source

add notes about starpu_bus_get_profiling_info

Samuel Thibault 6 years ago
parent
commit
6bc4342515
1 changed files with 5 additions and 1 deletions
  1. 5 1
      doc/doxygen/chapters/api/profiling.doxy

+ 5 - 1
doc/doxygen/chapters/api/profiling.doxy

@@ -1,7 +1,7 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
  * Copyright (C) 2010-2015,2017                           CNRS
- * Copyright (C) 2009-2011,2014,2016,2018                 Université de Bordeaux
+ * Copyright (C) 2009-2011,2014,2016,2018-2019            Université de Bordeaux
  * Copyright (C) 2011,2012                                Inria
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -151,8 +151,12 @@ Otherwise, a negative value is returned.
 
 \fn int starpu_bus_get_profiling_info(int busid, struct starpu_profiling_bus_info *bus_info)
 \ingroup API_Profiling
+
 todo
 
+See _starpu_profiling_bus_helper_display_summary in src/profiling/profiling_helpers.c for a usage example.
+Note that calling starpu_bus_get_profiling_info resets the counters to zero.
+
 \fn int starpu_bus_get_count(void)
 \ingroup API_Profiling
 Return the number of buses in the machine