Browse Source

doc/doxygen: update to packages 1.2

Nathalie Furmento 12 years ago
parent
commit
349e1eec87

+ 10 - 10
doc/doxygen/chapters/basic_examples.doxy

@@ -27,9 +27,9 @@ has a single implementation for CPU:
 The code can then be compiled and linked with GCC and the <c>-fplugin</c> flag:
 The code can then be compiled and linked with GCC and the <c>-fplugin</c> flag:
 
 
 \verbatim
 \verbatim
-$ gcc `pkg-config starpu-1.1 --cflags` hello-starpu.c \
-    -fplugin=`pkg-config starpu-1.1 --variable=gccplugin` \
-    `pkg-config starpu-1.1 --libs`
+$ gcc `pkg-config starpu-1.2 --cflags` hello-starpu.c \
+    -fplugin=`pkg-config starpu-1.2 --variable=gccplugin` \
+    `pkg-config starpu-1.2 --libs`
 \endverbatim
 \endverbatim
 
 
 The code can also be compiled without the StarPU C extension and will
 The code can also be compiled without the StarPU C extension and will
@@ -223,7 +223,7 @@ starpu_data_set_sequential_consistency_flag().
 
 
 \verbatim
 \verbatim
 $ make hello_world
 $ make hello_world
-cc $(pkg-config --cflags starpu-1.1)  $(pkg-config --libs starpu-1.1) hello_world.c -o hello_world
+cc $(pkg-config --cflags starpu-1.2)  $(pkg-config --libs starpu-1.2) hello_world.c -o hello_world
 $ ./hello_world
 $ ./hello_world
 Hello world (params = {1, 2.000000} )
 Hello world (params = {1, 2.000000} )
 Callback function (arg 42)
 Callback function (arg 42)
@@ -304,9 +304,9 @@ The program can be compiled and linked with GCC and the <c>-fplugin</c>
 flag:
 flag:
 
 
 \verbatim
 \verbatim
-$ gcc `pkg-config starpu-1.1 --cflags` vector_scal.c \
-    -fplugin=`pkg-config starpu-1.1 --variable=gccplugin` \
-    `pkg-config starpu-1.1 --libs`
+$ gcc `pkg-config starpu-1.2 --cflags` vector_scal.c \
+    -fplugin=`pkg-config starpu-1.2 --variable=gccplugin` \
+    `pkg-config starpu-1.2 --libs`
 \endverbatim
 \endverbatim
 
 
 And voilà!
 And voilà!
@@ -551,7 +551,7 @@ pointer.
 
 
 \verbatim
 \verbatim
 $ make vector_scal
 $ make vector_scal
-cc $(pkg-config --cflags starpu-1.1)  $(pkg-config --libs starpu-1.1)  vector_scal.c   -o vector_scal
+cc $(pkg-config --cflags starpu-1.2)  $(pkg-config --libs starpu-1.2)  vector_scal.c   -o vector_scal
 $ ./vector_scal
 $ ./vector_scal
 0.000000 3.000000 6.000000 9.000000 12.000000
 0.000000 3.000000 6.000000 9.000000 12.000000
 \endverbatim
 \endverbatim
@@ -688,8 +688,8 @@ be compiled at run-time when calling the function
 starpu_opencl_load_opencl_from_file().
 starpu_opencl_load_opencl_from_file().
 
 
 \verbatim
 \verbatim
-CFLAGS  += $(shell pkg-config --cflags starpu-1.1)
-LDFLAGS += $(shell pkg-config --libs starpu-1.1)
+CFLAGS  += $(shell pkg-config --cflags starpu-1.2)
+LDFLAGS += $(shell pkg-config --libs starpu-1.2)
 CC       = gcc
 CC       = gcc
 
 
 vector_scal: vector_scal.o vector_scal_cpu.o vector_scal_cuda.o vector_scal_opencl.o
 vector_scal: vector_scal.o vector_scal_cpu.o vector_scal_cuda.o vector_scal_opencl.o

+ 12 - 9
doc/doxygen/chapters/building.doxy

@@ -21,7 +21,7 @@ $ apt-cache search starpu
 To install what you need, type:
 To install what you need, type:
 
 
 \verbatim
 \verbatim
-$ sudo apt-get install libstarpu-1.0 libstarpu-dev
+$ sudo apt-get install libstarpu-1.2 libstarpu-dev
 \endverbatim
 \endverbatim
 
 
 \section InstallingFromSource Installing from Source
 \section InstallingFromSource Installing from Source
@@ -134,8 +134,8 @@ $ make install
 \endverbatim
 \endverbatim
 
 
 Libtool interface versioning information are included in
 Libtool interface versioning information are included in
-libraries names (libstarpu-1.0.so, libstarpumpi-1.0.so and
-libstarpufft-1.0.so).
+libraries names (libstarpu-1.2.so, libstarpumpi-1.2.so and
+libstarpufft-1.2.so).
 
 
 \section SettingUpYourOwnCode Setting up Your Own Code
 \section SettingUpYourOwnCode Setting up Your Own Code
 
 
@@ -160,17 +160,20 @@ The flags required to compile or link against StarPU are then
 accessible with the following commands:
 accessible with the following commands:
 
 
 \verbatim
 \verbatim
-$ pkg-config --cflags starpu-1.1  # options for the compiler
-$ pkg-config --libs starpu-1.1    # options for the linker
+$ pkg-config --cflags starpu-1.2  # options for the compiler
+$ pkg-config --libs starpu-1.2    # options for the linker
 \endverbatim
 \endverbatim
 
 
 Note that it is still possible to use the API provided in the version
 Note that it is still possible to use the API provided in the version
+1.0 of StarPU by calling <c>pkg-config</c> with the <c>starpu-1.0</c> package.
+Similar packages are provided for <c>starpumpi-1.0</c> and <c>starpufft-1.0</c>.
+It is also possible to use the API provided in the version
 0.9 of StarPU by calling <c>pkg-config</c> with the <c>libstarpu</c> package.
 0.9 of StarPU by calling <c>pkg-config</c> with the <c>libstarpu</c> package.
 Similar packages are provided for <c>libstarpumpi</c> and <c>libstarpufft</c>.
 Similar packages are provided for <c>libstarpumpi</c> and <c>libstarpufft</c>.
 
 
-Make sure that <c>pkg-config --libs starpu-1.1</c> actually produces some output
+Make sure that <c>pkg-config --libs starpu-1.2</c> actually produces some output
 before going further: <c>PKG_CONFIG_PATH</c> has to point to the place where
 before going further: <c>PKG_CONFIG_PATH</c> has to point to the place where
-<c>starpu-1.1.pc</c> was installed during <c>make install</c>.
+<c>starpu-1.2.pc</c> was installed during <c>make install</c>.
 
 
 Also pass the <c>--static</c> option if the application is to be
 Also pass the <c>--static</c> option if the application is to be
 linked statically.
 linked statically.
@@ -186,8 +189,8 @@ When using a Makefile, the following lines can be added to set the
 options for the compiler and the linker:
 options for the compiler and the linker:
 
 
 \verbatim
 \verbatim
-CFLAGS          +=      $$(pkg-config --cflags starpu-1.1)
-LDFLAGS         +=      $$(pkg-config --libs starpu-1.1)
+CFLAGS          +=      $$(pkg-config --cflags starpu-1.2)
+LDFLAGS         +=      $$(pkg-config --libs starpu-1.2)
 \endverbatim
 \endverbatim
 
 
 \subsection RunningABasicStarPUApplication Running a Basic StarPU Application
 \subsection RunningABasicStarPUApplication Running a Basic StarPU Application

+ 1 - 1
doc/doxygen/chapters/c_extensions.doxy

@@ -29,7 +29,7 @@ When StarPU has been installed with its GCC plug-in, programs that use
 these extensions can be compiled this way:
 these extensions can be compiled this way:
 
 
 \verbatim
 \verbatim
-$ gcc -c -fplugin=`pkg-config starpu-1.1 --variable=gccplugin` foo.c
+$ gcc -c -fplugin=`pkg-config starpu-1.2 --variable=gccplugin` foo.c
 \endverbatim
 \endverbatim
 
 
 When the plug-in is not available, the above <c>pkg-config</c>
 When the plug-in is not available, the above <c>pkg-config</c>

+ 2 - 2
doc/doxygen/chapters/fft_support.doxy

@@ -62,8 +62,8 @@ The flags required to compile or link against the FFT library are accessible
 with the following commands:
 with the following commands:
 
 
 \verbatim
 \verbatim
-$ pkg-config --cflags starpufft-1.0  # options for the compiler
-$ pkg-config --libs starpufft-1.0    # options for the linker
+$ pkg-config --cflags starpufft-1.2  # options for the compiler
+$ pkg-config --libs starpufft-1.2    # options for the linker
 \endverbatim
 \endverbatim
 
 
 Also pass the <c>--static</c> option if the application is to be linked statically.
 Also pass the <c>--static</c> option if the application is to be linked statically.

+ 2 - 2
doc/doxygen/chapters/mpi_support.doxy

@@ -27,8 +27,8 @@ The flags required to compile or link against the MPI layer are
 accessible with the following commands:
 accessible with the following commands:
 
 
 \verbatim
 \verbatim
-$ pkg-config --cflags starpumpi-1.0  # options for the compiler
-$ pkg-config --libs starpumpi-1.0    # options for the linker
+$ pkg-config --cflags starpumpi-1.2  # options for the compiler
+$ pkg-config --libs starpumpi-1.2    # options for the linker
 \endverbatim
 \endverbatim
 
 
 You also need pass the <c>--static</c> option if the application is to
 You also need pass the <c>--static</c> option if the application is to