Commit 860a7206 authored by Mathieu Faverge's avatar Mathieu Faverge

Merge branch 'doc' into 'master'

Doc

- improve user's doc style
- add some explanation about the code structure in the main doxygen 
- fix coverage in analysis sonarqube
- add a release job to automatize release publication
- change the cdash server to my.cdash.org which is more recent and reactive than cdash.inria.fr
- fix the version number, dates and authors in headers to prepare the release 0.9.2

See merge request solverstack/chameleon!147
parents 75528e23 29ed46b7
...@@ -9,7 +9,7 @@ stages: ...@@ -9,7 +9,7 @@ stages:
before_script: before_script:
- git submodule update --init --recursive - git submodule update --init --recursive
- source .gitlab-ci-env.sh $SIMU - source .gitlab-ci-env.sh $SIMU
- mkdir -p build - mkdir -p build-$VERSION
.build_script_template: &build_script .build_script_template: &build_script
stage: build stage: build
...@@ -17,15 +17,15 @@ before_script: ...@@ -17,15 +17,15 @@ before_script:
script: script:
- echo BUILD_OPTIONS $BUILD_OPTIONS - echo BUILD_OPTIONS $BUILD_OPTIONS
- echo VERSION $VERSION - echo VERSION $VERSION
- (cd build && - (cd build-$VERSION &&
scan-build -plist --intercept-first --analyze-headers -o analyzer_reports scan-build -plist --intercept-first --exclude CMakeFiles --analyze-headers -o analyzer_reports
cmake -C ../cmake_modules/gitlab-ci-initial-cache.cmake .. $BUILD_OPTIONS && cmake -C ../cmake_modules/gitlab-ci-initial-cache.cmake .. $BUILD_OPTIONS &&
scan-build -plist --intercept-first --analyze-headers -o analyzer_reports scan-build -plist --intercept-first --exclude CMakeFiles --analyze-headers -o analyzer_reports
ctest --no-compress-output -V -j 5 ctest --no-compress-output -V -j 5
-D ExperimentalBuild -D ExperimentalBuild
-D ExperimentalSubmit -D ExperimentalSubmit
| tee ../chameleon_${VERSION}.log) | tee ../chameleon_${VERSION}.log)
- (cd build && - (cd build-$VERSION &&
make install | tee -a ../chameleon_${VERSION}.log && make install | tee -a ../chameleon_${VERSION}.log &&
rm install/ -r) rm install/ -r)
...@@ -35,39 +35,38 @@ before_script: ...@@ -35,39 +35,38 @@ before_script:
script: script:
- echo TESTS_RESTRICTION $TESTS_RESTRICTION - echo TESTS_RESTRICTION $TESTS_RESTRICTION
- echo VERSION $VERSION - echo VERSION $VERSION
- (cd build && - (cd build-$VERSION &&
eval "ctest --no-compress-output -V eval "ctest --no-compress-output -V
$TESTS_RESTRICTION $TESTS_RESTRICTION
-D ExperimentalTest -D ExperimentalTest
-D ExperimentalCoverage -D ExperimentalCoverage
-D ExperimentalSubmit -D ExperimentalSubmit
| tee -a ../chameleon_${VERSION}.log") | tee -a ../chameleon_${VERSION}.log")
- lcov --directory build --capture --output-file ./chameleon_${VERSION}.lcov - lcov --directory build-$VERSION --capture --output-file ./chameleon_${VERSION}.lcov
build_starpu: build_openmp:
<<: *build_script <<: *build_script
artifacts: artifacts:
name: build_starpu name: build_openmp
expire_in: 48 hours expire_in: 48 hours
paths: paths:
- build - build-$VERSION
- chameleon_starpu.log - chameleon_openmp.log
variables: variables:
BUILD_OPTIONS: "-DCHAMELEON_USE_CUDA=ON -DCHAMELEON_USE_MPI=ON" BUILD_OPTIONS: "-DCHAMELEON_SCHED=OPENMP"
VERSION: starpu VERSION: openmp
build_starpu_simgrid: build_parsec:
<<: *build_script <<: *build_script
artifacts: artifacts:
name: build_starpu_simgrid name: build_parsec
expire_in: 48 hours expire_in: 48 hours
paths: paths:
- build - build-$VERSION
- chameleon_starpu_simgrid.log - chameleon_parsec.log
variables: variables:
SIMU: simu BUILD_OPTIONS: "-DCHAMELEON_SCHED=PARSEC"
BUILD_OPTIONS: "-DCHAMELEON_SIMULATION=ON -DCHAMELEON_USE_CUDA=ON -DCHAMELEON_USE_MPI=OFF" VERSION: parsec
VERSION: starpu_simgrid
build_quark: build_quark:
<<: *build_script <<: *build_script
...@@ -75,109 +74,112 @@ build_quark: ...@@ -75,109 +74,112 @@ build_quark:
name: build_quark name: build_quark
expire_in: 48 hours expire_in: 48 hours
paths: paths:
- build - build-$VERSION
- chameleon_quark.log - chameleon_quark.log
variables: variables:
BUILD_OPTIONS: "-DCHAMELEON_SCHED=QUARK" BUILD_OPTIONS: "-DCHAMELEON_SCHED=QUARK"
VERSION: quark VERSION: quark
build_parsec: build_starpu:
<<: *build_script <<: *build_script
artifacts: artifacts:
name: build_parsec name: build_starpu
expire_in: 48 hours expire_in: 48 hours
paths: paths:
- build - build-$VERSION
- chameleon_parsec.log - chameleon_starpu.log
variables: variables:
BUILD_OPTIONS: "-DCHAMELEON_SCHED=PARSEC" BUILD_OPTIONS: "-DCHAMELEON_USE_CUDA=ON -DCHAMELEON_USE_MPI=ON"
VERSION: parsec VERSION: starpu
build_openmp: build_starpu_simgrid:
<<: *build_script <<: *build_script
artifacts: artifacts:
name: build_openmp name: build_starpu_simgrid
expire_in: 48 hours expire_in: 48 hours
paths: paths:
- build - build-$VERSION
- chameleon_openmp.log - chameleon_starpu_simgrid.log
variables: variables:
BUILD_OPTIONS: "-DCHAMELEON_SCHED=OPENMP" SIMU: simu
VERSION: openmp BUILD_OPTIONS: "-DCHAMELEON_SIMULATION=ON -DCHAMELEON_USE_CUDA=ON -DCHAMELEON_USE_MPI=OFF"
VERSION: starpu_simgrid
test_starpu_branches: test_openmp_branches:
<<: *test_script <<: *test_script
variables: variables:
TESTS_RESTRICTION: "-R \"test_shm_s|test_mpi_s|time_ooc_shm_s|time_ooc_mpi_s\"" TESTS_RESTRICTION: "-R \"test_shm_s|test_mpi_s\""
VERSION: starpu VERSION: openmp
dependencies: dependencies:
- build_starpu - build_openmp
artifacts: artifacts:
name: test_starpu name: test_openmp
expire_in: 48 hours expire_in: 48 hours
paths: paths:
- build - build-$VERSION
- chameleon_starpu.log - chameleon_openmp.log
- chameleon_starpu.lcov - chameleon_openmp.lcov
only: only:
- branches - branches
except: except:
- master - master
- /^ci-.*$/
test_starpu_master: test_openmp_master:
<<: *test_script <<: *test_script
variables: variables:
TESTS_RESTRICTION: "-R \"_shm_|_mpi_\"" TESTS_RESTRICTION: "-R \"_shm_|_mpi_\""
VERSION: starpu VERSION: openmp
dependencies: dependencies:
- build_starpu - build_openmp
artifacts: artifacts:
name: test_starpu name: test_openmp
expire_in: 48 hours expire_in: 48 hours
paths: paths:
- build - build-$VERSION
- chameleon_starpu.log - chameleon_openmp.log
- chameleon_starpu.lcov - chameleon_openmp.lcov
only: only:
- master@solverstack/chameleon - master@solverstack/chameleon
- /^ci-.*$/
test_starpu_simgrid_branches: test_parsec_branches:
<<: *test_script <<: *test_script
variables: variables:
SIMU: simu TESTS_RESTRICTION: "-R \"test_shm_s|test_mpi_s\""
TESTS_RESTRICTION: "-R simu" VERSION: parsec
VERSION: starpu_simgrid
dependencies: dependencies:
- build_starpu_simgrid - build_parsec
artifacts: artifacts:
name: test_starpu_simgrid name: test_parsec
expire_in: 48 hours expire_in: 48 hours
paths: paths:
- build - build-$VERSION
- chameleon_starpu_simgrid.log - chameleon_parsec.log
- chameleon_starpu_simgrid.lcov - chameleon_parsec.lcov
only: only:
- branches - branches
except: except:
- master - master
- /^ci-.*$/
test_starpu_simgrid_master: test_parsec_master:
<<: *test_script <<: *test_script
variables: variables:
SIMU: simu TESTS_RESTRICTION: "-R \"_shm_|_mpi_\""
TESTS_RESTRICTION: "-R simu" VERSION: parsec
VERSION: starpu_simgrid
dependencies: dependencies:
- build_starpu_simgrid - build_parsec
artifacts: artifacts:
name: test_starpu_simgrid name: test_parsec
expire_in: 48 hours expire_in: 48 hours
paths: paths:
- build - build-$VERSION
- chameleon_starpu_simgrid.log - chameleon_parsec.log
- chameleon_starpu_simgrid.lcov - chameleon_parsec.lcov
only: only:
- master@solverstack/chameleon - master@solverstack/chameleon
- /^ci-.*$/
test_quark_branches: test_quark_branches:
<<: *test_script <<: *test_script
...@@ -190,13 +192,14 @@ test_quark_branches: ...@@ -190,13 +192,14 @@ test_quark_branches:
name: test_quark name: test_quark
expire_in: 48 hours expire_in: 48 hours
paths: paths:
- build - build-$VERSION
- chameleon_quark.log - chameleon_quark.log
- chameleon_quark.lcov - chameleon_quark.lcov
only: only:
- branches - branches
except: except:
- master - master
- /^ci-.*$/
test_quark_master: test_quark_master:
<<: *test_script <<: *test_script
...@@ -209,83 +212,90 @@ test_quark_master: ...@@ -209,83 +212,90 @@ test_quark_master:
name: test_quark name: test_quark
expire_in: 48 hours expire_in: 48 hours
paths: paths:
- build - build-$VERSION
- chameleon_quark.log - chameleon_quark.log
- chameleon_quark.lcov - chameleon_quark.lcov
only: only:
- master@solverstack/chameleon - master@solverstack/chameleon
- /^ci-.*$/
test_parsec_branches: test_starpu_branches:
<<: *test_script <<: *test_script
variables: variables:
TESTS_RESTRICTION: "-R \"test_shm_s|test_mpi_s\"" TESTS_RESTRICTION: "-R \"test_shm_s|test_mpi_s|time_ooc_shm_s|time_ooc_mpi_s\""
VERSION: parsec VERSION: starpu
dependencies: dependencies:
- build_parsec - build_starpu
artifacts: artifacts:
name: test_parsec name: test_starpu
expire_in: 48 hours expire_in: 48 hours
paths: paths:
- build - build-$VERSION
- chameleon_parsec.log - chameleon_starpu.log
- chameleon_parsec.lcov - chameleon_starpu.lcov
only: only:
- branches - branches
except: except:
- master - master
- /^ci-.*$/
test_parsec_master: test_starpu_master:
<<: *test_script <<: *test_script
variables: variables:
TESTS_RESTRICTION: "-R \"_shm_|_mpi_\"" TESTS_RESTRICTION: "-R \"_shm_|_mpi_\""
VERSION: parsec VERSION: starpu
dependencies: dependencies:
- build_parsec - build_starpu
artifacts: artifacts:
name: test_parsec name: test_starpu
expire_in: 48 hours expire_in: 48 hours
paths: paths:
- build - build-$VERSION
- chameleon_parsec.log - chameleon_starpu.log
- chameleon_parsec.lcov - chameleon_starpu.lcov
only: only:
- master@solverstack/chameleon - master@solverstack/chameleon
- /^ci-.*$/
test_openmp_branches: test_starpu_simgrid_branches:
<<: *test_script <<: *test_script
variables: variables:
TESTS_RESTRICTION: "-R \"test_shm_s|test_mpi_s\"" SIMU: simu
VERSION: openmp TESTS_RESTRICTION: "-R simu"
VERSION: starpu_simgrid
dependencies: dependencies:
- build_openmp - build_starpu_simgrid
artifacts: artifacts:
name: test_openmp name: test_starpu_simgrid
expire_in: 48 hours expire_in: 48 hours
paths: