doc: update function prototypes

doc/doxygen/chapters/api/data_interfaces.doxy

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010-2017                                CNRS
+ * Copyright (C) 2010-2018                                CNRS
  * Copyright (C) 2011-2014,2017                           Inria
  * Copyright (C) 2009-2011,2014-2018                      Université de Bordeaux
  *
@@ -50,8 +50,8 @@ Per-interface data transfer methods.
 \var void *(*starpu_data_interface_ops::to_pointer)(void *data_interface, unsigned node)
     Return the current pointer (if any) for the given interface on the given node.
 
-\var int (*starpu_data_interface_ops::pointer_is_inside)(void *data_interface, unsigned node, void *pointer)
-    Return whether the given \p pointer is within the data for the given interface on the given node.
+\var int (*starpu_data_interface_ops::pointer_is_inside)(void *data_interface, unsigned node, void *ptr)
+    Return whether the given \p ptr is within the data for the given interface on the given node.
 
 \var size_t (*starpu_data_interface_ops::get_size)(starpu_data_handle_t handle)
     Return an estimation of the size of data, for performance models.
@@ -532,9 +532,9 @@ Return the pointer associated with \p handle on node \p node or <c>NULL</c>
 if handle’s interface does not support this operation or data for this
 \p handle is not allocated on that \p node.
 
-\fn int starpu_data_pointer_is_inside(starpu_data_handle_t handle, unsigned node, void *pointer)
+\fn int starpu_data_pointer_is_inside(starpu_data_handle_t handle, unsigned node, void *ptr)
 \ingroup API_Data_Interfaces
-Return whether the given \p pointer is within the data for \p handle on node \p
+Return whether the given \p ptr is within the data for \p handle on node \p
 node (1) or not (0). If the handle interface does not support this operation,
 and thus the result is unknown, -1 is returned.
 

doc/doxygen/chapters/api/data_management.doxy

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010-2017                                CNRS
+ * Copyright (C) 2010-2018                                CNRS
  * Copyright (C) 2011-2012,2017                           Inria
  * Copyright (C) 2009-2011,2014-2017                      Université de Bordeaux
  *
@@ -374,7 +374,7 @@ memory.
 ::STARPU_ACQUIRE_NO_NODE and ::STARPU_ACQUIRE_NO_NODE_LOCK_ALL can be used instead of an
 explicit node number.
 
-\fn int starpu_data_acquire_on_node_cb_sequential_consistency_sync_jobids(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode, void (*callback)(void *), void *arg, int sequential_consistency, long *pre_sync_jobid, long *post_sync_jobid)
+\fn int starpu_data_acquire_on_node_cb_sequential_consistency_sync_jobids(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode, void (*callback)(void *), void *arg, int sequential_consistency, int quick, long *pre_sync_jobid, long *post_sync_jobid)
 \ingroup API_Data_Management
 This is the same as starpu_data_acquire_on_node_cb_sequential_consistency(),
 except that the \e pre_sync_jobid and \e post_sync_jobid parameters can be used

doc/doxygen/chapters/api/initialization.doxy

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010-2017                                CNRS
+ * Copyright (C) 2010-2018                                CNRS
  * Copyright (C) 2011-2012,2014,2017                      Inria
  * Copyright (C) 2009-2011,2014,2018                      Université de Bordeaux
  *
@@ -281,7 +281,7 @@ the argument was <c>NULL</c>.
 \ingroup API_Initialization_and_Termination
 Return 1 if StarPU is already initialized.
 
-\fn int starpu_wait_initialized(void)
+\fn void starpu_wait_initialized(void)
 \ingroup API_Initialization_and_Termination
 Wait for starpu_init() call to finish.
 
@@ -297,7 +297,7 @@ This flag should be passed to starpu_get_next_bindid() and
 starpu_bind_thread_on() when binding a thread which will significantly eat CPU
 time, and should thus have its own dedicated CPU.
 
-\fn int starpu_get_next_bindid(unsigned flags, unsigned *preferred, unsigned npreferred)
+\fn unsigned starpu_get_next_bindid(unsigned flags, unsigned *preferred, unsigned npreferred)
 \ingroup API_Initialization_and_Termination
 This returns a PU binding ID which can be used to bind threads with
 starpu_bind_thread_on(). \p flags can be set to STARPU_THREAD_ACTIVE or 0.

doc/doxygen/chapters/api/insert_task.doxy

@@ -213,7 +213,7 @@ data, then starpu_codelet_pack_arg_fini().
 Initialize struct starpu_codelet_pack_arg before calling starpu_codelet_pack_arg() and
 starpu_codelet_pack_arg_fini(). This will simply initialize the content of the structure.
 
-\fn void starpu_codelet_pack_arg(struct starpu_codelet_pack_arg_data *state, void *ptr, size_t ptr_size)
+\fn void starpu_codelet_pack_arg(struct starpu_codelet_pack_arg_data *state, const void *ptr, size_t ptr_size)
 \ingroup API_Insert_Task
 Pack one argument into struct starpu_codelet_pack_arg \p state. That structure
 has to be initialized before with starpu_codelet_pack_arg_init(), and after all

doc/doxygen/chapters/api/modularized_scheduler.doxy

@@ -1,7 +1,7 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
  * Copyright (C) 2013-2014                                Inria
- * Copyright (C) 2014-2017                                CNRS
+ * Copyright (C) 2014-2018                                CNRS
  * Copyright (C) 2009-2011,2014-2015,2017-2018                 Université de Bordeaux
  * Copyright (C) 2013                                     Simon Archipoff
  *
@@ -251,7 +251,7 @@ The actual scheduler
 @name Flow-control Fifo Component API
 \ingroup API_Modularized_Scheduler
 
-\fn int starpu_sched_component_can_push(struct starpu_sched_component * component)
+\fn int starpu_sched_component_can_push(struct starpu_sched_component * component, struct starpu_sched_component * to)
 \ingroup API_Modularized_Scheduler
 default function for the can_push component method, just calls can_push of parents until one of them returns non-zero
 

doc/doxygen/chapters/api/scheduling_policy.doxy

@@ -1,7 +1,7 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
  * Copyright (C) 2011-2013                                Inria
- * Copyright (C) 2010-2017                                CNRS
+ * Copyright (C) 2010-2018                                CNRS
  * Copyright (C) 2009-2011,2014-2018                      Université de Bordeaux
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -296,11 +296,4 @@ started and we know how long it will take.
 The scheduling policies indicates if the worker may pop tasks from the list of other workers
 or if there is a central list with task for all the workers
 
-\fn void starpu_sched_break(struct starpu_task *task)
-\ingroup API_Scheduling_Policy
-This should be called just after a scheduling decision for task \p task was
-made. It will raise SIGTRAP if the ::STARPU_TASK_BREAK_ON_SCHED environment
-variable was used, which thus breakpoints inside a debugger, thus allowing to
-inspect why that scheduling decision was made.
-
 */

doc/doxygen/refman.tex

@@ -1,7 +1,7 @@
 % StarPU --- Runtime system for heterogeneous multicore architectures.
 %
 % Copyright (C) 2013,2015-2016,2018                      Inria
-% Copyright (C) 2013-2017                                CNRS
+% Copyright (C) 2013-2018                                CNRS
 % Copyright (C) 2014,2018                                Université de Bordeaux
 %
 % StarPU is free software; you can redistribute it and/or modify
@@ -116,7 +116,7 @@ Documentation License”.
 \hypertarget{SchedulingContextHypervisor}{}
 \input{SchedulingContextHypervisor}
 
-\chapter{Modularized Scheduler}
+\chapter{Modularized Schedulers}
 \label{ModularizedScheduler}
 \hypertarget{ModularizedScheduler}{}
 \input{ModularizedScheduler}
@@ -158,7 +158,7 @@ Documentation License”.
 \hypertarget{FFTSupport}{}
 \input{FFTSupport}
 
-\chapter{MIC/SCC Support}
+\chapter{MIC Xeon Phi / SCC Support}
 \label{MICSCCSupport}
 \hypertarget{MICSCCSupport}{}
 \input{MICSCCSupport}
@@ -183,7 +183,7 @@ Documentation License”.
 \hypertarget{SimGridSupport}{}
 \input{SimGridSupport}
 
-\chapter{OpenMP Runtime Support}
+\chapter{The StarPU OpenMP Runtime Support (SORS)}
 \label{OpenMPRuntimeSupport}
 \hypertarget{OpenMPRuntimeSupport}{}
 \input{OpenMPRuntimeSupport}
@@ -208,6 +208,9 @@ Documentation License”.
 \chapter{Module Index}
 \input{modules}
 
+\chapter{Deprecated List}
+\input{deprecated}
+
 \chapter{Module Documentation a.k.a StarPU's API}
 \label{ModuleDocumentation}
 \hypertarget{ModuleDocumentation}{}
@@ -303,7 +306,6 @@ Documentation License”.
 \input{starpu__tree_8h}
 \input{starpu__util_8h}
 \input{starpu__worker_8h}
-\input{starpu__mpi_8h}
 \input{starpufft_8h}
 \input{sc__hypervisor_8h}
 \input{sc__hypervisor__config_8h}
@@ -323,7 +325,7 @@ Documentation License”.
 \hypertarget{FullSourceCodeVectorScal}{}
 \input{FullSourceCodeVectorScal}
 
-\chapter{GNU Free Documentation License}
+\chapter{The GNU Free Documentation License}
 \label{GNUFreeDocumentationLicense}
 \hypertarget{GNUFreeDocumentationLicense}{}
 \input{GNUFreeDocumentationLicense}