From 0828cf97caa6c91c33d3b39f404b575423e6d852 Mon Sep 17 00:00:00 2001 From: Nathalie Furmento Date: Wed, 13 Mar 2024 08:46:40 +0100 Subject: [PATCH] doc: small fixes --- doc/doxygen/Makefile.am | 10 +++++----- .../chapters/starpu_basics/basic_examples.doxy | 8 ++++---- .../code/{vector_scal_c.c => basics_vector_scal_c.c} | 0 .../{vector_scal_cpu.c => basics_vector_scal_cpu.c} | 0 ...{vector_scal_cuda.c => basics_vector_scal_cuda.c} | 0 ...tor_scal_opencl.c => basics_vector_scal_opencl.c} | 0 ...delet.cl => basics_vector_scal_opencl_codelet.cl} | 0 .../starpu_basics/scaling_vector_example.doxy | 12 ++++++------ .../starpu_introduction/introduction_intro.doxy | 2 ++ doc/doxygen_web_basics/Makefile.am | 10 +++++----- doc/doxygen_web_basics/doxygen-config.cfg.in | 3 ++- 11 files changed, 24 insertions(+), 21 deletions(-) rename doc/doxygen/chapters/starpu_basics/code/{vector_scal_c.c => basics_vector_scal_c.c} (100%) rename doc/doxygen/chapters/starpu_basics/code/{vector_scal_cpu.c => basics_vector_scal_cpu.c} (100%) rename doc/doxygen/chapters/starpu_basics/code/{vector_scal_cuda.c => basics_vector_scal_cuda.c} (100%) rename doc/doxygen/chapters/starpu_basics/code/{vector_scal_opencl.c => basics_vector_scal_opencl.c} (100%) rename doc/doxygen/chapters/starpu_basics/code/{vector_scal_opencl_codelet.cl => basics_vector_scal_opencl_codelet.cl} (100%) diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am index affdc85948..f88979688d 100644 --- a/doc/doxygen/Makefile.am +++ b/doc/doxygen/Makefile.am @@ -44,11 +44,11 @@ chapters = \ chapters/starpu_basics/data_management.doxy \ chapters/starpu_basics/scheduling.doxy \ chapters/starpu_basics/examples_sources.doxy \ - chapters/starpu_basics/code/vector_scal_c.c \ - chapters/starpu_basics/code/vector_scal_cpu.c \ - chapters/starpu_basics/code/vector_scal_cuda.c \ - chapters/starpu_basics/code/vector_scal_opencl.c \ - chapters/starpu_basics/code/vector_scal_opencl_codelet.cl \ + chapters/starpu_basics/code/basics_vector_scal_c.c \ + chapters/starpu_basics/code/basics_vector_scal_cpu.c \ + chapters/starpu_basics/code/basics_vector_scal_cuda.c \ + chapters/starpu_basics/code/basics_vector_scal_opencl.c \ + chapters/starpu_basics/code/basics_vector_scal_opencl_codelet.cl \ chapters/starpu_applications/applications_intro.doxy \ chapters/starpu_applications/vector_scaling.doxy \ chapters/starpu_applications/code/vector_scal_c.c \ diff --git a/doc/doxygen/chapters/starpu_basics/basic_examples.doxy b/doc/doxygen/chapters/starpu_basics/basic_examples.doxy index 33d6813536..60cd650cae 100644 --- a/doc/doxygen/chapters/starpu_basics/basic_examples.doxy +++ b/doc/doxygen/chapters/starpu_basics/basic_examples.doxy @@ -1,6 +1,6 @@ /* StarPU --- Runtime system for heterogeneous multicore architectures. * - * Copyright (C) 2009-2023 Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria + * Copyright (C) 2009-2024 Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria * * StarPU is free software; you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by @@ -407,7 +407,7 @@ that the vector pointer returned by ::STARPU_VECTOR_GET_PTR is here a pointer in GPU memory, so that it can be passed as such to the kernel call vector_mult_cuda. -\snippet vector_scal_cuda.c To be included. You should update doxygen if you see this text. +\snippet basics_vector_scal_cuda.c To be included. You should update doxygen if you see this text. \subsection DefinitionOfTheOpenCLKernel Definition of the OpenCL Kernel @@ -430,7 +430,7 @@ which returns a cl_mem (which is not a device pointer, but an OpenCL handle), which can be passed as such to the OpenCL kernel. The difference is important when using partitioning, see \ref PartitioningData. -\snippet vector_scal_opencl.c To be included. You should update doxygen if you see this text. +\snippet basics_vector_scal_opencl.c To be included. You should update doxygen if you see this text. \subsection DefinitionOfTheMainCode Definition of the Main Code @@ -441,7 +441,7 @@ starpu_codelet::cuda_funcs and starpu_codelet::opencl_funcs are set to define the pointers to the CUDA and OpenCL implementations of the task. -\snippet vector_scal_c.c To be included. You should update doxygen if you see this text. +\snippet basics_vector_scal_c.c To be included. You should update doxygen if you see this text. \subsection ExecutionOfHybridVectorScaling Execution of Hybrid Vector Scaling diff --git a/doc/doxygen/chapters/starpu_basics/code/vector_scal_c.c b/doc/doxygen/chapters/starpu_basics/code/basics_vector_scal_c.c similarity index 100% rename from doc/doxygen/chapters/starpu_basics/code/vector_scal_c.c rename to doc/doxygen/chapters/starpu_basics/code/basics_vector_scal_c.c diff --git a/doc/doxygen/chapters/starpu_basics/code/vector_scal_cpu.c b/doc/doxygen/chapters/starpu_basics/code/basics_vector_scal_cpu.c similarity index 100% rename from doc/doxygen/chapters/starpu_basics/code/vector_scal_cpu.c rename to doc/doxygen/chapters/starpu_basics/code/basics_vector_scal_cpu.c diff --git a/doc/doxygen/chapters/starpu_basics/code/vector_scal_cuda.c b/doc/doxygen/chapters/starpu_basics/code/basics_vector_scal_cuda.c similarity index 100% rename from doc/doxygen/chapters/starpu_basics/code/vector_scal_cuda.c rename to doc/doxygen/chapters/starpu_basics/code/basics_vector_scal_cuda.c diff --git a/doc/doxygen/chapters/starpu_basics/code/vector_scal_opencl.c b/doc/doxygen/chapters/starpu_basics/code/basics_vector_scal_opencl.c similarity index 100% rename from doc/doxygen/chapters/starpu_basics/code/vector_scal_opencl.c rename to doc/doxygen/chapters/starpu_basics/code/basics_vector_scal_opencl.c diff --git a/doc/doxygen/chapters/starpu_basics/code/vector_scal_opencl_codelet.cl b/doc/doxygen/chapters/starpu_basics/code/basics_vector_scal_opencl_codelet.cl similarity index 100% rename from doc/doxygen/chapters/starpu_basics/code/vector_scal_opencl_codelet.cl rename to doc/doxygen/chapters/starpu_basics/code/basics_vector_scal_opencl_codelet.cl diff --git a/doc/doxygen/chapters/starpu_basics/scaling_vector_example.doxy b/doc/doxygen/chapters/starpu_basics/scaling_vector_example.doxy index 69d18f90d4..7337f180a0 100644 --- a/doc/doxygen/chapters/starpu_basics/scaling_vector_example.doxy +++ b/doc/doxygen/chapters/starpu_basics/scaling_vector_example.doxy @@ -1,6 +1,6 @@ /* StarPU --- Runtime system for heterogeneous multicore architectures. * - * Copyright (C) 2009-2021 Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria + * Copyright (C) 2009-2021, 2024 Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria * * StarPU is free software; you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by @@ -18,25 +18,25 @@ \section MainApplication Main Application -\snippet vector_scal_c.c To be included. You should update doxygen if you see this text. +\snippet basics_vector_scal_c.c To be included. You should update doxygen if you see this text. \section CPUKernel CPU Kernel -\snippet vector_scal_cpu.c To be included. You should update doxygen if you see this text. +\snippet basics_vector_scal_cpu.c To be included. You should update doxygen if you see this text. \section CUDAKernel CUDA Kernel -\snippet vector_scal_cuda.c To be included. You should update doxygen if you see this text. +\snippet basics_vector_scal_cuda.c To be included. You should update doxygen if you see this text. \section OpenCLKernel OpenCL Kernel \subsection InvokingtheKernel Invoking the Kernel -\snippet vector_scal_opencl.c To be included. You should update doxygen if you see this text. +\snippet basics_vector_scal_opencl.c To be included. You should update doxygen if you see this text. \subsection SourceoftheKernel Source of the Kernel -\snippet vector_scal_opencl_codelet.cl To be included. You should update doxygen if you see this text. +\snippet basics_vector_scal_opencl_codelet.cl To be included. You should update doxygen if you see this text. */ diff --git a/doc/doxygen/chapters/starpu_introduction/introduction_intro.doxy b/doc/doxygen/chapters/starpu_introduction/introduction_intro.doxy index a192c5d89d..f2878c5491 100644 --- a/doc/doxygen/chapters/starpu_introduction/introduction_intro.doxy +++ b/doc/doxygen/chapters/starpu_introduction/introduction_intro.doxy @@ -19,6 +19,8 @@ \foreword \webforeword + +# we need to keep 2 blank lines above \section Motivation Motivation // This is a comment and it will be removed before the file is processed by doxygen diff --git a/doc/doxygen_web_basics/Makefile.am b/doc/doxygen_web_basics/Makefile.am index ff661202cb..8cad47c532 100644 --- a/doc/doxygen_web_basics/Makefile.am +++ b/doc/doxygen_web_basics/Makefile.am @@ -36,11 +36,11 @@ chapters = \ ../doxygen/chapters/starpu_basics/data_management.doxy \ ../doxygen/chapters/starpu_basics/scheduling.doxy \ ../doxygen/chapters/starpu_basics/examples_sources.doxy \ - ../doxygen/chapters/starpu_basics/code/vector_scal_c.c \ - ../doxygen/chapters/starpu_basics/code/vector_scal_cpu.c \ - ../doxygen/chapters/starpu_basics/code/vector_scal_cuda.c \ - ../doxygen/chapters/starpu_basics/code/vector_scal_opencl.c \ - ../doxygen/chapters/starpu_basics/code/vector_scal_opencl_codelet.cl \ + ../doxygen/chapters/starpu_basics/code/basics_vector_scal_c.c \ + ../doxygen/chapters/starpu_basics/code/basics_vector_scal_cpu.c \ + ../doxygen/chapters/starpu_basics/code/basics_vector_scal_cuda.c \ + ../doxygen/chapters/starpu_basics/code/basics_vector_scal_opencl.c \ + ../doxygen/chapters/starpu_basics/code/basics_vector_scal_opencl_codelet.cl \ ../doxygen/chapters/files.doxy \ ../doxygen/chapters/fdl_1_3.doxy diff --git a/doc/doxygen_web_basics/doxygen-config.cfg.in b/doc/doxygen_web_basics/doxygen-config.cfg.in index 5f70a3725a..d6244ac8e9 100644 --- a/doc/doxygen_web_basics/doxygen-config.cfg.in +++ b/doc/doxygen_web_basics/doxygen-config.cfg.in @@ -28,7 +28,8 @@ INPUT = @top_srcdir@/doc/doxygen/chapters/starpu_basics/basics_ @top_srcdir@/doc/doxygen/chapters/api EXAMPLE_PATH = @top_srcdir@/doc/doxygen \ - @top_srcdir@/doc/doxygen/chapters + @top_srcdir@/doc/doxygen/chapters \ + @top_srcdir@/doc/doxygen/chapters/starpu_basics/code INPUT_FILTER = @top_builddir@/doc/doxygen/doxygen_filter.sh