Bläddra i källkod

doc: define @node and @chapter in the main document and not in the individual chapters

Nathalie Furmento 13 år sedan
förälder
incheckning
bd47f03921

+ 0 - 3
doc/chapters/advanced-api.texi

@@ -6,9 +6,6 @@
 @c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
 @c See the file starpu.texi for copying conditions.
 
-@node StarPU Advanced API
-@chapter StarPU Advanced API
-
 @menu
 * Defining a new data interface::  
 * Multiformat Data Interface::  

+ 0 - 3
doc/chapters/advanced-examples.texi

@@ -6,9 +6,6 @@
 @c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
 @c See the file starpu.texi for copying conditions.
 
-@node Advanced Examples
-@chapter Advanced Examples
-
 @menu
 * Using multiple implementations of a codelet::
 * Enabling implementation according to capabilities::

+ 0 - 3
doc/chapters/basic-api.texi

@@ -6,9 +6,6 @@
 @c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
 @c See the file starpu.texi for copying conditions.
 
-@node StarPU Basic API
-@chapter StarPU Basic API
-
 @menu
 * Initialization and Termination::  Initialization and Termination methods
 * Workers' Properties::         Methods to enumerate workers' properties

+ 0 - 3
doc/chapters/basic-examples.texi

@@ -6,9 +6,6 @@
 @c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
 @c See the file starpu.texi for copying conditions.
 
-@node Basic Examples
-@chapter Basic Examples
-
 @menu
 * Compiling and linking options::  
 * Hello World::                 Submitting Tasks

+ 0 - 3
doc/chapters/c-extensions.texi

@@ -4,9 +4,6 @@
 @c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
 @c See the file starpu.texi for copying conditions.
 
-@node C Extensions
-@chapter C Extensions
-
 @cindex C extensions
 @cindex GCC plug-in
 

+ 0 - 3
doc/chapters/configuration.texi

@@ -6,9 +6,6 @@
 @c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
 @c See the file starpu.texi for copying conditions.
 
-@node Configuring StarPU
-@chapter Configuring StarPU
-
 @menu
 * Compilation configuration::   
 * Execution configuration through environment variables::  

+ 1 - 4
doc/chapters/fft-support.texi

@@ -2,13 +2,10 @@
 
 @c This file is part of the StarPU Handbook.
 @c Copyright (C) 2009--2011  Universit@'e de Bordeaux 1
-@c Copyright (C) 2010, 2011  Centre National de la Recherche Scientifique
+@c Copyright (C) 2010, 2011, 2012  Centre National de la Recherche Scientifique
 @c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
 @c See the file starpu.texi for copying conditions.
 
-@node StarPU FFT support
-@chapter StarPU FFT support
-
 StarPU provides @code{libstarpufft}, a library whose design is very similar to
 both fftw and cufft, the difference being that it takes benefit from both CPUs
 and GPUs. It should however be noted that GPUs do not have the same precision as

+ 1 - 4
doc/chapters/installing.texi

@@ -2,13 +2,10 @@
 
 @c This file is part of the StarPU Handbook.
 @c Copyright (C) 2009--2011  Universit@'e de Bordeaux 1
-@c Copyright (C) 2010, 2011  Centre National de la Recherche Scientifique
+@c Copyright (C) 2010, 2011, 2012  Centre National de la Recherche Scientifique
 @c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
 @c See the file starpu.texi for copying conditions.
 
-@node Installing StarPU
-@chapter Installing StarPU
-
 @menu
 * Downloading StarPU::          
 * Configuration of StarPU::     

+ 1 - 4
doc/chapters/introduction.texi

@@ -2,13 +2,10 @@
 
 @c This file is part of the StarPU Handbook.
 @c Copyright (C) 2009--2011  Universit@'e de Bordeaux 1
-@c Copyright (C) 2010, 2011  Centre National de la Recherche Scientifique
+@c Copyright (C) 2010, 2011, 2012  Centre National de la Recherche Scientifique
 @c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
 @c See the file starpu.texi for copying conditions.
 
-@node Introduction
-@chapter Introduction to StarPU
-
 @menu
 * Motivation::                  Why StarPU ?
 * StarPU in a Nutshell::        The Fundamentals of StarPU

+ 0 - 3
doc/chapters/mpi-support.texi

@@ -6,9 +6,6 @@
 @c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
 @c See the file starpu.texi for copying conditions.
 
-@node StarPU MPI support
-@chapter StarPU MPI support
-
 The integration of MPI transfers within task parallelism is done in a
 very natural way by the means of asynchronous interactions between the
 application and StarPU.  This is implemented in a separate libstarpumpi library

+ 0 - 3
doc/chapters/perf-feedback.texi

@@ -6,9 +6,6 @@
 @c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
 @c See the file starpu.texi for copying conditions.
 
-@node Performance feedback
-@chapter Performance feedback
-
 @menu
 * On-line::                     On-line performance feedback
 * Off-line::                    Off-line performance feedback

+ 0 - 3
doc/chapters/perf-optimization.texi

@@ -6,9 +6,6 @@
 @c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
 @c See the file starpu.texi for copying conditions.
 
-@node Performance optimization
-@chapter How to optimize performance with StarPU
-
 TODO: improve!
 
 @menu

+ 1 - 4
doc/chapters/scaling-vector-example.texi

@@ -2,13 +2,10 @@
 
 @c This file is part of the StarPU Handbook.
 @c Copyright (C) 2009--2011  Universit@'e de Bordeaux 1
-@c Copyright (C) 2010, 2011  Centre National de la Recherche Scientifique
+@c Copyright (C) 2010, 2011, 2012  Centre National de la Recherche Scientifique
 @c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
 @c See the file starpu.texi for copying conditions.
 
-@node Full source code for the 'Scaling a Vector' example
-@appendix Full source code for the 'Scaling a Vector' example
-
 @menu
 * Main application::            
 * CPU Kernel::                 

+ 0 - 3
doc/chapters/tips-tricks.texi

@@ -6,9 +6,6 @@
 @c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
 @c See the file starpu.texi for copying conditions.
 
-@node Tips and Tricks
-@chapter Tips and Tricks to know about
-
 @menu
 * Per-worker library initialization::  How to initialize a computation library once for each worker?
 @end menu

+ 1 - 4
doc/chapters/using.texi

@@ -2,13 +2,10 @@
 
 @c This file is part of the StarPU Handbook.
 @c Copyright (C) 2009--2011  Universit@'e de Bordeaux 1
-@c Copyright (C) 2010, 2011  Centre National de la Recherche Scientifique
+@c Copyright (C) 2010, 2011, 2012  Centre National de la Recherche Scientifique
 @c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
 @c See the file starpu.texi for copying conditions.
 
-@node Using StarPU
-@chapter Using StarPU
-
 @menu
 * Setting flags for compiling and linking applications::  
 * Running a basic StarPU application::  

+ 33 - 2
doc/starpu.texi

@@ -77,8 +77,8 @@ was last updated on @value{UPDATED}.
 * StarPU Basic API::            The Basic API to use StarPU
 * StarPU Advanced API::         Advanced use of StarPU
 * Configuring StarPU::          How to configure StarPU
-* Full source code for the 'Scaling a Vector' example::
-* GNU Free Documentation License::    How you can copy and share this manual.
+* Full source code for the 'Scaling a Vector' example::  
+* GNU Free Documentation License::  How you can copy and share this manual.
 * Function Index::              Index of C functions.
 * Datatype Index::              Index of C datatypes
 @end menu
@@ -87,84 +87,112 @@ was last updated on @value{UPDATED}.
 @c Introduction to StarPU
 @c ---------------------------------------------------------------------
 
+@node Introduction
+@chapter Introduction to StarPU
 @include chapters/introduction.texi
 
 @c ---------------------------------------------------------------------
 @c Installing StarPU
 @c ---------------------------------------------------------------------
 
+@node Installing StarPU
+@chapter Installing StarPU
 @include chapters/installing.texi
 
 @c ---------------------------------------------------------------------
 @c Using StarPU
 @c ---------------------------------------------------------------------
 
+@node Using StarPU
+@chapter Using StarPU
 @include chapters/using.texi
 
 @c ---------------------------------------------------------------------
 @c Basic Examples
 @c ---------------------------------------------------------------------
 
+@node Basic Examples
+@chapter Basic Examples
 @include chapters/basic-examples.texi
 
 @c ---------------------------------------------------------------------
 @c Advanced Examples
 @c ---------------------------------------------------------------------
 
+@node Advanced Examples
+@chapter Advanced Examples
 @include chapters/advanced-examples.texi
 
 @c ---------------------------------------------------------------------
 @c Performance options
 @c ---------------------------------------------------------------------
 
+@node Performance optimization
+@chapter How to optimize performance with StarPU
 @include chapters/perf-optimization.texi
 
 @c ---------------------------------------------------------------------
 @c Performance feedback
 @c ---------------------------------------------------------------------
 
+@node Performance feedback
+@chapter Performance feedback
 @include chapters/perf-feedback.texi
 
 @c ---------------------------------------------------------------------
 @c Tips and Tricks
 @c ---------------------------------------------------------------------
 
+@node Tips and Tricks
+@chapter Tips and Tricks to know about
 @include chapters/tips-tricks.texi
 
 @c ---------------------------------------------------------------------
 @c MPI support
 @c ---------------------------------------------------------------------
 
+@node StarPU MPI support
+@chapter StarPU MPI support
 @include chapters/mpi-support.texi
 
 @c ---------------------------------------------------------------------
 @c FFT support
 @c ---------------------------------------------------------------------
 
+@node StarPU FFT support
+@chapter StarPU FFT support
 @include chapters/fft-support.texi
 
 @c ---------------------------------------------------------------------
 @c C Extensions
 @c ---------------------------------------------------------------------
 
+@node C Extensions
+@chapter C Extensions
 @include chapters/c-extensions.texi
 
 @c ---------------------------------------------------------------------
 @c StarPU API
 @c ---------------------------------------------------------------------
 
+@node StarPU Basic API
+@chapter StarPU Basic API
 @include chapters/basic-api.texi
 
 @c ---------------------------------------------------------------------
 @c Advanced Topics
 @c ---------------------------------------------------------------------
 
+@node StarPU Advanced API
+@chapter StarPU Advanced API
 @include chapters/advanced-api.texi
 
 @c ---------------------------------------------------------------------
 @c Configuration options
 @c ---------------------------------------------------------------------
 
+@node Configuring StarPU
+@chapter Configuring StarPU
 @include chapters/configuration.texi
 
 @c ---------------------------------------------------------------------
@@ -175,11 +203,14 @@ was last updated on @value{UPDATED}.
 @c Full source code for the 'Scaling a Vector' example
 @c ---------------------------------------------------------------------
 
+@node Full source code for the 'Scaling a Vector' example
+@appendix Full source code for the 'Scaling a Vector' example
 @include chapters/scaling-vector-example.texi
 
 @c ---------------------------------------------------------------------
 @c License
 @c ---------------------------------------------------------------------
+
 @node GNU Free Documentation License
 @appendix GNU Free Documentation License
 @include chapters/fdl-1.3.texi