Browse Source

Fix duplicate documentation sections

Samuel Thibault 5 years ago
parent
commit
e9addf9605

+ 1 - 1
doc/doxygen/chapters/330_scheduling_contexts.doxy

@@ -19,7 +19,7 @@
 
 
 TODO: improve!
 TODO: improve!
 
 
-\section GeneralIdeas General Ideas
+\section ContextGeneralIdeas General Ideas
 
 
 Scheduling contexts represent abstracts sets of workers that allow the
 Scheduling contexts represent abstracts sets of workers that allow the
 programmers to control the distribution of computational resources
 programmers to control the distribution of computational resources

+ 1 - 1
doc/doxygen/chapters/350_scheduling_policy_definition.doxy

@@ -17,7 +17,7 @@
 
 
 /*! \page HowToDefineANewSchedulingPolicy How To Define A New Scheduling Policy
 /*! \page HowToDefineANewSchedulingPolicy How To Define A New Scheduling Policy
 
 
-\section Introduction Introduction
+\section NewSchedulingPolicy_Introduction Introduction
 
 
 StarPU provides two ways of defining a scheduling policy, a basic monolithic
 StarPU provides two ways of defining a scheduling policy, a basic monolithic
 way, and a modular way.
 way, and a modular way.

File diff suppressed because it is too large
+ 43 - 43
doc/doxygen/chapters/370_online_performance_tools.doxy


+ 1 - 1
doc/doxygen/chapters/401_out_of_core.doxy

@@ -17,7 +17,7 @@
 
 
 /*! \page OutOfCore Out Of Core
 /*! \page OutOfCore Out Of Core
 
 
-\section Introduction Introduction
+\section OutOfCore_Introduction Introduction
 
 
 When using StarPU, one may need to store more data than what the main memory
 When using StarPU, one may need to store more data than what the main memory
 (RAM) can store. This part describes the method to add a new memory node on a
 (RAM) can store. This part describes the method to add a new memory node on a

+ 1 - 1
doc/doxygen/chapters/415_fault_tolerance.doxy

@@ -16,7 +16,7 @@
 
 
 /*! \page FaultTolerance Fault Tolerance
 /*! \page FaultTolerance Fault Tolerance
 
 
-\section Introduction Introduction
+\section FaultTolerance_Introduction Introduction
 
 
 Due to e.g. hardware error, some tasks may fail, or even complete nodes may
 Due to e.g. hardware error, some tasks may fail, or even complete nodes may
 fail.  For now, StarPU provides some support for failure of tasks.
 fail.  For now, StarPU provides some support for failure of tasks.

+ 1 - 1
doc/doxygen/chapters/420_fft_support.doxy

@@ -64,7 +64,7 @@ the task completion, and thus permits to enqueue a series of tasks.
 
 
 All functions are defined in \ref API_FFT_Support.
 All functions are defined in \ref API_FFT_Support.
 
 
-\section Compilation Compilation
+\section FFTCompilation Compilation
 
 
 The flags required to compile or link against the FFT library are accessible
 The flags required to compile or link against the FFT library are accessible
 with the following commands:
 with the following commands:

+ 1 - 1
doc/doxygen/chapters/430_mic_support.doxy

@@ -16,7 +16,7 @@
 
 
 /*! \page MICSupport MIC Xeon Phi Support
 /*! \page MICSupport MIC Xeon Phi Support
 
 
-\section Compilation Compilation
+\section MICCompilation Compilation
 
 
 MIC Xeon Phi support actually needs two compilations of StarPU, one for the host and one for
 MIC Xeon Phi support actually needs two compilations of StarPU, one for the host and one for
 the device. The <c>PATH</c> environment variable has to include the path to the
 the device. The <c>PATH</c> environment variable has to include the path to the

+ 12 - 12
doc/doxygen/chapters/450_native_fortran_support.doxy

@@ -28,9 +28,9 @@ symbols in the same Fortran code has unspecified behaviour.
 See \ref APIMIX for a discussion about valid and unspecified
 See \ref APIMIX for a discussion about valid and unspecified
 combinations.
 combinations.
 
 
-\section Implementation Implementation Details and Specificities
+\section NFImplementation Implementation Details and Specificities
 
 
-\subsection Prerequisites Prerequisites
+\subsection NFPrerequisites Prerequisites
 
 
 The Native Fortran support relies on Fortran 2008 specific constructs,
 The Native Fortran support relies on Fortran 2008 specific constructs,
 as well as on the support of interoperability of assumed-shape arrays
 as well as on the support of interoperability of assumed-shape arrays
@@ -43,7 +43,7 @@ not to work with GNU GFortran < 4.9, Intel Fortran Compiler < 2016.
 See Section \ref OldFortran on information on how to write StarPU
 See Section \ref OldFortran on information on how to write StarPU
 Fortran code with older compilers.
 Fortran code with older compilers.
 
 
-\subsection Configuration Configuration
+\subsection NFConfiguration Configuration
 
 
 The Native Fortran API is enabled and its companion
 The Native Fortran API is enabled and its companion
 <c>fstarpu_mod.f90</c> Fortran module source file is installed
 <c>fstarpu_mod.f90</c> Fortran module source file is installed
@@ -54,13 +54,13 @@ disable-fortran "--disable-fortran". Conditional compiled source codes
 may check for the availability of the Native Fortran Support by testing
 may check for the availability of the Native Fortran Support by testing
 whether the preprocessor macro <c>STARPU_HAVE_FC</c> is defined or not.
 whether the preprocessor macro <c>STARPU_HAVE_FC</c> is defined or not.
 
 
-\subsection Examples Examples
+\subsection NFExamples Examples
 
 
 Several examples using the Native Fortran API are provided in
 Several examples using the Native Fortran API are provided in
 StarPU's <c>examples/native_fortran/</c> examples directory, to showcase
 StarPU's <c>examples/native_fortran/</c> examples directory, to showcase
 the Fortran flavor of various basic and more advanced StarPU features.
 the Fortran flavor of various basic and more advanced StarPU features.
 
 
-\subsection AppCompile Compiling a Native Fortran Application
+\subsection NFAppCompile Compiling a Native Fortran Application
 
 
 The Fortran module <c>fstarpu_mod.f90</c> installed in StarPU's
 The Fortran module <c>fstarpu_mod.f90</c> installed in StarPU's
 <c>include/</c> directory provides all the necessary API definitions. It
 <c>include/</c> directory provides all the necessary API definitions. It
@@ -73,7 +73,7 @@ examples directory comes with its own dedicated Makefile for out-of-tree
 build. Such example Makefiles may be used as starting points for
 build. Such example Makefiles may be used as starting points for
 building application codes with StarPU.
 building application codes with StarPU.
 
 
-\section Idioms Fortran Translation for Common StarPU API Idioms
+\section NFIdioms Fortran Translation for Common StarPU API Idioms
 
 
 All these examples assume that the standard Fortran module <c>iso_c_binding</c>
 All these examples assume that the standard Fortran module <c>iso_c_binding</c>
 is in use.
 is in use.
@@ -141,7 +141,7 @@ is in use.
         call fstarpu_codelet_add_buffer(my_cl, FSTARPU_RW.ior.FSTARPU_LOCALITY)
         call fstarpu_codelet_add_buffer(my_cl, FSTARPU_RW.ior.FSTARPU_LOCALITY)
 \endcode
 \endcode
 
 
-\section InitExit Uses, Initialization and Shutdown
+\section NFInitExit Uses, Initialization and Shutdown
 
 
 The snippet below show an example of minimal StarPU code using the
 The snippet below show an example of minimal StarPU code using the
 Native Fortran support. The program should <c>use</c> the standard
 Native Fortran support. The program should <c>use</c> the standard
@@ -153,7 +153,7 @@ the runtime engine and frees all internal StarPU data structures.
 
 
 \snippet nf_initexit.f90 To be included. You should update doxygen if you see this text.
 \snippet nf_initexit.f90 To be included. You should update doxygen if you see this text.
 
 
-\section InsertTask Fortran Flavor of StarPU's Variadic Insert_task
+\section NFInsertTask Fortran Flavor of StarPU's Variadic Insert_task
 
 
 Fortran does not have a construction similar to C variadic functions on which
 Fortran does not have a construction similar to C variadic functions on which
 starpu_insert_task() relies at the time of this writing. However, Fortran's variable
 starpu_insert_task() relies at the time of this writing. However, Fortran's variable
@@ -182,7 +182,7 @@ Example extracted from nf_vector.f90:
             C_NULL_PTR /))                                ! no more args
             C_NULL_PTR /))                                ! no more args
 \endcode
 \endcode
 
 
-\section Structs Functions and Subroutines Expecting Data Structures Arguments
+\section NFStructs Functions and Subroutines Expecting Data Structures Arguments
 
 
 Several StarPU structures that are expected to be passed to the C API,
 Several StarPU structures that are expected to be passed to the C API,
 are replaced by function/subroutine wrapper sets to allocate, set fields
 are replaced by function/subroutine wrapper sets to allocate, set fields
@@ -214,8 +214,8 @@ structure:
         call fstarpu_codelet_free(cl_vec)
         call fstarpu_codelet_free(cl_vec)
 \endcode
 \endcode
 
 
-\section Notes Additional Notes about the Native Fortran Support
-\subsection OldFortran Using StarPU with Older Fortran Compilers
+\section NFNotes Additional Notes about the Native Fortran Support
+\subsection NFOldFortran Using StarPU with Older Fortran Compilers
 
 
 When using older compilers, Fortran applications may still interoperate
 When using older compilers, Fortran applications may still interoperate
 with StarPU using C marshalling functions as exemplified in StarPU's
 with StarPU using C marshalling functions as exemplified in StarPU's
@@ -230,7 +230,7 @@ Note that this marshalled FORTRAN support remains available even
 when specifying \c configure option \ref disable-fortran "--disable-fortran"
 when specifying \c configure option \ref disable-fortran "--disable-fortran"
 (which only disables StarPU's native Fortran layer).
 (which only disables StarPU's native Fortran layer).
 
 
-\subsection APIMIX Valid API Mixes and Language Mixes
+\subsection NFAPIMIX Valid API Mixes and Language Mixes
 
 
 Mixing uses of
 Mixing uses of
 <c>fstarpu_</c> and <c>starpu_</c> symbols in the same
 <c>fstarpu_</c> and <c>starpu_</c> symbols in the same

+ 15 - 15
doc/doxygen/chapters/480_openmp_runtime_support.doxy

@@ -27,9 +27,9 @@ inline or as outlined functions.
 
 
 All functions are defined in \ref API_OpenMP_Runtime_Support.
 All functions are defined in \ref API_OpenMP_Runtime_Support.
 
 
-\section Implementation Implementation Details and Specificities
+\section OMPImplementation Implementation Details and Specificities
 
 
-\subsection MainThread Main Thread
+\subsection OMPMainThread Main Thread
 
 
 When using the SORS, the main thread gets involved in executing OpenMP tasks
 When using the SORS, the main thread gets involved in executing OpenMP tasks
 just like every other threads, in order to be compliant with the
 just like every other threads, in order to be compliant with the
@@ -37,7 +37,7 @@ specification execution model. This contrasts with StarPU's usual
 execution model where the main thread submit tasks but does not take
 execution model where the main thread submit tasks but does not take
 part in executing them.
 part in executing them.
 
 
-\subsection TaskSemantics Extended Task Semantics
+\subsection OMPTaskSemantics Extended Task Semantics
 
 
 The semantics of tasks generated by the SORS are extended with respect
 The semantics of tasks generated by the SORS are extended with respect
 to regular StarPU tasks in that SORS' tasks may block and be preempted
 to regular StarPU tasks in that SORS' tasks may block and be preempted
@@ -45,7 +45,7 @@ by SORS call, whereas regular StarPU tasks cannot. SORS tasks may
 coexist with regular StarPU tasks. However, only the tasks created using
 coexist with regular StarPU tasks. However, only the tasks created using
 SORS API functions inherit from extended semantics.
 SORS API functions inherit from extended semantics.
 
 
-\section Configuration Configuration
+\section OMPConfiguration Configuration
 
 
 The SORS can be compiled into <c>libstarpu</c> through
 The SORS can be compiled into <c>libstarpu</c> through
 the \c configure option \ref enable-openmp "--enable-openmp".
 the \c configure option \ref enable-openmp "--enable-openmp".
@@ -53,7 +53,7 @@ Conditional compiled source codes may check for the
 availability of the OpenMP Runtime Support by testing whether the C
 availability of the OpenMP Runtime Support by testing whether the C
 preprocessor macro <c>STARPU_OPENMP</c> is defined or not.
 preprocessor macro <c>STARPU_OPENMP</c> is defined or not.
 
 
-\section InitExit Initialization and Shutdown
+\section OMPInitExit Initialization and Shutdown
 
 
 The SORS needs to be executed/terminated by the
 The SORS needs to be executed/terminated by the
 starpu_omp_init() / starpu_omp_shutdown() instead of
 starpu_omp_init() / starpu_omp_shutdown() instead of
@@ -81,7 +81,7 @@ static void omp_destructor(void)
 \sa starpu_omp_init()
 \sa starpu_omp_init()
 \sa starpu_omp_shutdown()
 \sa starpu_omp_shutdown()
 
 
-\section Parallel Parallel Regions and Worksharing
+\section OMPSharing Parallel Regions and Worksharing
 
 
 The SORS provides functions to create OpenMP parallel regions as well as
 The SORS provides functions to create OpenMP parallel regions as well as
 mapping work on participating workers. The current implementation does
 mapping work on participating workers. The current implementation does
@@ -251,13 +251,13 @@ starpu_omp_master() function variants.
 \sa starpu_omp_single_copyprivate_inline_begin()
 \sa starpu_omp_single_copyprivate_inline_begin()
 \sa starpu_omp_single_copyprivate_inline_end()
 \sa starpu_omp_single_copyprivate_inline_end()
 
 
-\section Task Tasks
+\section OMPTask Tasks
 
 
 The SORS implements the necessary support of OpenMP 3.1 and OpenMP 4.0's
 The SORS implements the necessary support of OpenMP 3.1 and OpenMP 4.0's
 so-called explicit tasks, together with OpenMP 4.0's data dependency
 so-called explicit tasks, together with OpenMP 4.0's data dependency
 management.
 management.
 
 
-\subsection OMPTask Explicit Tasks
+\subsection OMPTaskExplicit Explicit Tasks
 Explicit OpenMP tasks are created with the SORS using the
 Explicit OpenMP tasks are created with the SORS using the
 starpu_omp_task_region() function. The implementation supports
 starpu_omp_task_region() function. The implementation supports
 <c>if</c>, <c>final</c>, <c>untied</c> and <c>mergeable</c> clauses
 <c>if</c>, <c>final</c>, <c>untied</c> and <c>mergeable</c> clauses
@@ -313,7 +313,7 @@ void parallel_region_f(void *buffers[], void *args)
 \sa struct starpu_omp_task_region_attr
 \sa struct starpu_omp_task_region_attr
 \sa starpu_omp_task_region()
 \sa starpu_omp_task_region()
 
 
-\subsection DataDependencies Data Dependencies
+\subsection OMPDataDependencies Data Dependencies
 The SORS implements inter-tasks data dependencies as specified in OpenMP
 The SORS implements inter-tasks data dependencies as specified in OpenMP
 4.0. Data dependencies are expressed using regular StarPU data handles
 4.0. Data dependencies are expressed using regular StarPU data handles
 (\ref starpu_data_handle_t) plugged into the task's <c>attr.cl</c>
 (\ref starpu_data_handle_t) plugged into the task's <c>attr.cl</c>
@@ -331,7 +331,7 @@ dependencies between sibling tasks. Consequently the behaviour is
 unspecified if dependencies are expressed beween tasks that have not
 unspecified if dependencies are expressed beween tasks that have not
 been created by the same parent task.
 been created by the same parent task.
 
 
-\subsection TaskSyncs TaskWait and TaskGroup
+\subsection OMPTaskSyncs TaskWait and TaskGroup
 The SORS implements both the <c>taskwait</c> and <c>taskgroup</c> OpenMP
 The SORS implements both the <c>taskwait</c> and <c>taskgroup</c> OpenMP
 task synchronization constructs specified in OpenMP 4.0, with the
 task synchronization constructs specified in OpenMP 4.0, with the
 starpu_omp_taskwait() and starpu_omp_taskgroup() functions respectively.
 starpu_omp_taskwait() and starpu_omp_taskgroup() functions respectively.
@@ -403,12 +403,12 @@ void parallel_region_f(void *buffers[], void *args)
 \sa starpu_omp_taskgroup_inline_begin()
 \sa starpu_omp_taskgroup_inline_begin()
 \sa starpu_omp_taskgroup_inline_end()
 \sa starpu_omp_taskgroup_inline_end()
 
 
-\section Synchronization Synchronization Support
+\section OMPSynchronization Synchronization Support
 
 
 The SORS implements objects and method to build common OpenMP
 The SORS implements objects and method to build common OpenMP
 synchronization constructs.
 synchronization constructs.
 
 
-\subsection SimpleLock Simple Locks
+\subsection OMPSimpleLock Simple Locks
 
 
 The SORS Simple Locks are opaque starpu_omp_lock_t objects enabling multiple
 The SORS Simple Locks are opaque starpu_omp_lock_t objects enabling multiple
 tasks to synchronize with each others, following the Simple Lock
 tasks to synchronize with each others, following the Simple Lock
@@ -427,7 +427,7 @@ Simple Locks as they incur less processing overhead than Nestable Locks.
 \sa starpu_omp_unset_lock()
 \sa starpu_omp_unset_lock()
 \sa starpu_omp_test_lock()
 \sa starpu_omp_test_lock()
 
 
-\subsection NestableLock Nestable Locks
+\subsection OMPNestableLock Nestable Locks
 
 
 The SORS Nestable Locks are opaque starpu_omp_nest_lock_t objects enabling
 The SORS Nestable Locks are opaque starpu_omp_nest_lock_t objects enabling
 multiple tasks to synchronize with each others, following the Nestable
 multiple tasks to synchronize with each others, following the Nestable
@@ -448,7 +448,7 @@ incur less processing overhead than Nestable Locks.
 \sa starpu_omp_unset_nest_lock()
 \sa starpu_omp_unset_nest_lock()
 \sa starpu_omp_test_nest_lock()
 \sa starpu_omp_test_nest_lock()
 
 
-\subsection Critical Critical Sections
+\subsection OMPCritical Critical Sections
 
 
 The SORS implements support for OpenMP critical sections through the
 The SORS implements support for OpenMP critical sections through the
 family of \ref starpu_omp_critical functions. Critical sections may optionally
 family of \ref starpu_omp_critical functions. Critical sections may optionally
@@ -460,7 +460,7 @@ a named one or the anonymous one.
 \sa starpu_omp_critical_inline_begin()
 \sa starpu_omp_critical_inline_begin()
 \sa starpu_omp_critical_inline_end()
 \sa starpu_omp_critical_inline_end()
 
 
-\subsection Barrier Barriers
+\subsection OMPBarrier Barriers
 
 
 The SORS provides the starpu_omp_barrier() function to implement
 The SORS provides the starpu_omp_barrier() function to implement
 barriers over parallel region teams. In accordance with the OpenMP
 barriers over parallel region teams. In accordance with the OpenMP

+ 1 - 1
doc/doxygen/chapters/490_clustering_a_machine.doxy

@@ -16,7 +16,7 @@
 
 
 /*! \page ClusteringAMachine Clustering A Machine
 /*! \page ClusteringAMachine Clustering A Machine
 
 
-\section GeneralIdeas General Ideas
+\section ClusteringGeneralIdeas General Ideas
 
 
 Clusters are a concept introduced in this
 Clusters are a concept introduced in this
 <a href="https://hal.inria.fr/view/index/docid/1181135">paper</a>.
 <a href="https://hal.inria.fr/view/index/docid/1181135">paper</a>.

+ 1 - 1
doc/doxygen/chapters/501_environment_variables.doxy

@@ -20,7 +20,7 @@
 The behavior of the StarPU library and tools may be tuned thanks to
 The behavior of the StarPU library and tools may be tuned thanks to
 the following environment variables.
 the following environment variables.
 
 
-\section ConfiguringWorkers Configuring Workers
+\section EnvConfiguringWorkers Configuring Workers
 
 
 <dl>
 <dl>
 
 

+ 2 - 10
doc/doxygen/chapters/510_configure_options.doxy

@@ -96,8 +96,8 @@ means of the tool <c>pkg-config</c>.
 
 
 <dt>--with-hwloc=<c>prefix</c></dt>
 <dt>--with-hwloc=<c>prefix</c></dt>
 <dd>
 <dd>
-\anchor with-hwloc
-\addindex __configure__--with-hwloc
+\anchor with-hwloc-prefix
+\addindex __configure__--with-hwloc-prefix
 Specify <c>hwloc</c> should be used by StarPU. <c>hwloc</c> should be found in the
 Specify <c>hwloc</c> should be used by StarPU. <c>hwloc</c> should be found in the
 directory specified by <c>prefix</c>
 directory specified by <c>prefix</c>
 </dd>
 </dd>
@@ -651,14 +651,6 @@ Disable the build of tests.
 Disable the build of examples.
 Disable the build of examples.
 </dd>
 </dd>
 
 
-<dt>--disable-build-tests</dt>
-<dd>
-\anchor disable-build-tests
-\addindex __configure__--disable-build-tests
-Disable the build of tests.
-</dd>
-
-
 <dt>--enable-sc-hypervisor</dt>
 <dt>--enable-sc-hypervisor</dt>
 <dd>
 <dd>
 \anchor enable-sc-hypervisor
 \anchor enable-sc-hypervisor