Browse Source

doc: minor updates

Nathalie Furmento 12 years ago
parent
commit
e94a3eb256
3 changed files with 12 additions and 10 deletions
  1. 6 6
      doc/chapters/installing.texi
  2. 4 4
      doc/chapters/introduction.texi
  3. 2 0
      doc/chapters/using.texi

+ 6 - 6
doc/chapters/installing.texi

@@ -46,7 +46,7 @@ $ wget http://starpu.gforge.inria.fr/testing/starpu-nightly-latest.tar.gz
 @end example
 @end example
 
 
 And finally, current development version is also accessible via svn.
 And finally, current development version is also accessible via svn.
-It should be done only if you need the very latest changes (i.e. less
+It should be used only if you need the very latest changes (i.e. less
 than a day!)@footnote{The client side of the software Subversion can
 than a day!)@footnote{The client side of the software Subversion can
 be obtained from @url{http://subversion.tigris.org}. If you
 be obtained from @url{http://subversion.tigris.org}. If you
 are running on Windows, you will probably prefer to use
 are running on Windows, you will probably prefer to use
@@ -65,12 +65,12 @@ recommended.  It allows for topology aware scheduling, which improves
 performance.  @code{hwloc} is available in major free operating system
 performance.  @code{hwloc} is available in major free operating system
 distributions, and for most operating systems.
 distributions, and for most operating systems.
 
 
-If hwloc is not available on your system, the option
+If @code{hwloc} is not available on your system, the option
 @code{--without-hwloc} should be explicitely given when calling the
 @code{--without-hwloc} should be explicitely given when calling the
-configure script. If hwloc is installed with a @code{pkg-config} file,
+@code{configure} script. If @code{hwloc} is installed with a @code{pkg-config} file,
 no option is required, it will be detected automatically, otherwise
 no option is required, it will be detected automatically, otherwise
-the @code{with-hwloc=prefix} should be used to specify the location
-of hwloc.
+@code{with-hwloc=prefix} should be used to specify the location
+of @code{hwloc}.
 
 
 @node Configuration of StarPU
 @node Configuration of StarPU
 @section Configuration of StarPU
 @section Configuration of StarPU
@@ -108,7 +108,7 @@ is advised to to put them all in a separate directory. It is then
 easier to cleanup, and this allows to compile several configurations
 easier to cleanup, and this allows to compile several configurations
 out of the same source tree. For that, simply enter the directory
 out of the same source tree. For that, simply enter the directory
 where you want the compilation to produce its files, and invoke the
 where you want the compilation to produce its files, and invoke the
-configure script located in the StarPU source directory.
+@code{configure} script located in the StarPU source directory.
 
 
 @example
 @example
 $ mkdir build
 $ mkdir build

+ 4 - 4
doc/chapters/introduction.texi

@@ -9,6 +9,8 @@
 @menu
 @menu
 * Motivation::                  Why StarPU ?
 * Motivation::                  Why StarPU ?
 * StarPU in a Nutshell::        The Fundamentals of StarPU
 * StarPU in a Nutshell::        The Fundamentals of StarPU
+* Glossary::
+* Research Papers::
 @end menu
 @end menu
 
 
 @node Motivation
 @node Motivation
@@ -72,8 +74,6 @@ The remainder of this section describes the main concepts used in StarPU.
 @menu
 @menu
 * Codelet and Tasks::
 * Codelet and Tasks::
 * StarPU Data Management Library::
 * StarPU Data Management Library::
-* Glossary::
-* Research Papers::
 @end menu
 @end menu
 
 
 @c explain the notion of codelet and task (i.e. g(A, B)
 @c explain the notion of codelet and task (i.e. g(A, B)
@@ -125,7 +125,7 @@ allows multiple copies of the same data to reside at the same time on
 several processing units as long as it is not modified.
 several processing units as long as it is not modified.
 
 
 @node Glossary
 @node Glossary
-@subsection Glossary
+@section Glossary
 
 
 A @b{codelet} records pointers to various implementations of the same
 A @b{codelet} records pointers to various implementations of the same
 theoretical function.
 theoretical function.
@@ -178,7 +178,7 @@ unregister it.
 
 
 
 
 @node Research Papers
 @node Research Papers
-@subsection Research Papers
+@section Research Papers
 
 
 Research papers about StarPU can be found at
 Research papers about StarPU can be found at
 @url{http://runtime.bordeaux.inria.fr/Publis/Keyword/STARPU.html}.
 @url{http://runtime.bordeaux.inria.fr/Publis/Keyword/STARPU.html}.

+ 2 - 0
doc/chapters/using.texi

@@ -16,6 +16,8 @@
 @node Setting flags for compiling
 @node Setting flags for compiling
 @section Setting flags for compiling, linking and running applications
 @section Setting flags for compiling, linking and running applications
 
 
+StarPU provides a pkg-config executable to obtain relevant compiler
+and linker flags.
 Compiling and linking an application against StarPU may require to use
 Compiling and linking an application against StarPU may require to use
 specific flags or libraries (for instance @code{CUDA} or @code{libspe2}).
 specific flags or libraries (for instance @code{CUDA} or @code{libspe2}).
 To this end, it is possible to use the @code{pkg-config} tool.
 To this end, it is possible to use the @code{pkg-config} tool.