浏览代码

doc/doxygen: small fixes

Nathalie Furmento 11 年之前
父节点
当前提交
4e375cc4bd

+ 1 - 0
doc/doxygen/Makefile.am

@@ -184,6 +184,7 @@ dox_inputs = $(DOX_CONFIG) 				\
 	$(top_srcdir)/include/starpu_bound.h		\
 	$(top_srcdir)/include/starpu_bound.h		\
 	$(top_srcdir)/include/starpu_scheduler.h	\
 	$(top_srcdir)/include/starpu_scheduler.h	\
 	$(top_srcdir)/include/starpu_sched_ctx.h	\
 	$(top_srcdir)/include/starpu_sched_ctx.h	\
+	$(top_srcdir)/include/starpu_sched_ctx_hypervisor.h		\
 	$(top_srcdir)/include/starpu_top.h		\
 	$(top_srcdir)/include/starpu_top.h		\
 	$(top_srcdir)/include/starpu_hash.h		\
 	$(top_srcdir)/include/starpu_hash.h		\
 	$(top_srcdir)/include/starpu_rand.h		\
 	$(top_srcdir)/include/starpu_rand.h		\

+ 3 - 3
doc/doxygen/chapters/api/scheduling_context_hypervisor.doxy

@@ -57,12 +57,12 @@ can be used to construct new resize strategies.
         Indicates which workers can be moved and which ones are fixed
         Indicates which workers can be moved and which ones are fixed
 \var sc_hypervisor_policy_config:: new_workers_max_idle
 \var sc_hypervisor_policy_config:: new_workers_max_idle
         Indicates the maximum idle time accepted before a resize is triggered for the workers that just arrived in the new context
         Indicates the maximum idle time accepted before a resize is triggered for the workers that just arrived in the new context
-\var sc_hypervisor_policy_config::empty_ctx_max_idle
-         Indicates that above this context we allow removing all workers
 \var sc_hypervisor_policy_config::ispeed_w_sample
 \var sc_hypervisor_policy_config::ispeed_w_sample
          Indicates the sample used to compute the instant speed per worker
          Indicates the sample used to compute the instant speed per worker
 \var sc_hypervisor_policy_config::ispeed_ctx_sample
 \var sc_hypervisor_policy_config::ispeed_ctx_sample
         Indicates the sample used to compute the instant speed per ctxs
         Indicates the sample used to compute the instant speed per ctxs
+\var sc_hypervisor_policy_config::time_sample
+        todo
 
 
 \struct sc_hypervisor_wrapper
 \struct sc_hypervisor_wrapper
 \ingroup API_Scheduling_Context_Hypervisor
 \ingroup API_Scheduling_Context_Hypervisor
@@ -178,7 +178,7 @@ Returns the configuration structure of a context
 \ingroup API_Scheduling_Context_Hypervisor
 \ingroup API_Scheduling_Context_Hypervisor
 Set a certain configuration to a contexts
 Set a certain configuration to a contexts
 
 
-\fn int *sc_hypervisor_get_sched_ctxs()
+\fn unsigned *sc_hypervisor_get_sched_ctxs()
 \ingroup API_Scheduling_Context_Hypervisor
 \ingroup API_Scheduling_Context_Hypervisor
     Gets the contexts managed by the hypervisor
     Gets the contexts managed by the hypervisor
 
 

+ 1 - 9
doc/doxygen/chapters/api/scheduling_context_hypervisor_usage.doxy

@@ -97,14 +97,6 @@ Change dynamically the total number of flops of a context, move the deadline of
 \ingroup API_Scheduling_Context_Hypervisor_usage
 \ingroup API_Scheduling_Context_Hypervisor_usage
 Change dynamically the number of the elapsed flops in a context, modify the past in order to better compute the speed 
 Change dynamically the number of the elapsed flops in a context, modify the past in order to better compute the speed 
 
 
-\fn int *sc_hypervisor_get_sched_ctxs()
-\ingroup API_Scheduling_Context_Hypervisor_usage
-    Gets the contexts managed by the hypervisor
-
-\fn int sc_hypervisor_get_nsched_ctxs()
-\ingroup API_Scheduling_Context_Hypervisor_usage
-    Gets the number of contexts managed by the hypervisor
-
 \fn void sc_hypervisor_ctl(unsigned sched_ctx, ...)
 \fn void sc_hypervisor_ctl(unsigned sched_ctx, ...)
 \ingroup API_Scheduling_Context_Hypervisor_usage
 \ingroup API_Scheduling_Context_Hypervisor_usage
 Inputs conditions to the context sched_ctx with the following
 Inputs conditions to the context sched_ctx with the following
@@ -196,4 +188,4 @@ needed to be executed before computing the speed of a context
 This macro is used when calling sc_hypervisor_ctl() and must be
 This macro is used when calling sc_hypervisor_ctl() and must be
 followed by 1 arguments
 followed by 1 arguments
 
 
-*/
+*/