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
This diff is collapsed.
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
# #
# @copyright 2009-2014 The University of Tennessee and The University of # @copyright 2009-2014 The University of Tennessee and The University of
# Tennessee Research Foundation. All rights reserved. # Tennessee Research Foundation. All rights reserved.
# @copyright 2012-2018 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria, # @copyright 2012-2019 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
# Univ. Bordeaux. All rights reserved. # Univ. Bordeaux. All rights reserved.
# #
### ###
...@@ -17,12 +17,12 @@ ...@@ -17,12 +17,12 @@
# Univ. of California Berkeley, # Univ. of California Berkeley,
# Univ. of Colorado Denver. # Univ. of Colorado Denver.
# #
# @version 1.0.0 # @version 0.9.2
# @author Cedric Castagnede # @author Cedric Castagnede
# @author Emmanuel Agullo # @author Emmanuel Agullo
# @author Mathieu Faverge # @author Mathieu Faverge
# @author Florent Pruvost # @author Florent Pruvost
# @date 2012-07-13 # @date 2014-11-16
# #
### ###
cmake_minimum_required(VERSION 3.3) cmake_minimum_required(VERSION 3.3)
...@@ -36,9 +36,9 @@ if("${PROJECT_SOURCE_DIR}" STREQUAL "${PROJECT_BINARY_DIR}") ...@@ -36,9 +36,9 @@ if("${PROJECT_SOURCE_DIR}" STREQUAL "${PROJECT_BINARY_DIR}")
endif() endif()
# set project version number # set project version number
set(CHAMELEON_VERSION_MAJOR 1) set(CHAMELEON_VERSION_MAJOR 0)
set(CHAMELEON_VERSION_MINOR 0) set(CHAMELEON_VERSION_MINOR 9)
set(CHAMELEON_VERSION_MICRO 0) set(CHAMELEON_VERSION_MICRO 2)
set(CHAMELEON_CMAKE_DIR "" CACHE PATH "Directory of CHAMELEON CMake modules, can be external to the project") set(CHAMELEON_CMAKE_DIR "" CACHE PATH "Directory of CHAMELEON CMake modules, can be external to the project")
...@@ -916,6 +916,7 @@ if( CHAMELEON_SCHED_OPENMP ) ...@@ -916,6 +916,7 @@ if( CHAMELEON_SCHED_OPENMP )
endif( CHAMELEON_SCHED_OPENMP ) endif( CHAMELEON_SCHED_OPENMP )
# getopt # getopt
unset(CMAKE_REQUIRED_LIBRARIES)
check_include_files(getopt.h CHAMELEON_HAVE_GETOPT_H) check_include_files(getopt.h CHAMELEON_HAVE_GETOPT_H)
if (CHAMELEON_HAVE_GETOPT_H) if (CHAMELEON_HAVE_GETOPT_H)
check_function_exists(getopt_long CHAMELEON_HAVE_GETOPT_LONG) check_function_exists(getopt_long CHAMELEON_HAVE_GETOPT_LONG)
...@@ -1019,7 +1020,7 @@ include(CTest) ...@@ -1019,7 +1020,7 @@ include(CTest)
if(${CMAKE_Fortran_COMPILER_ID} STREQUAL "Intel") if(${CMAKE_Fortran_COMPILER_ID} STREQUAL "Intel")
message(STATUS "Add -nofor_main to the Fortran linker (Intel compiler)") message(STATUS "Add -nofor_main to the Fortran linker (Intel compiler)")
set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} -nofor_main") set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} -nofor_main")
endif(_match_ifort) endif()
# Testing executables # Testing executables
if(CHAMELEON_ENABLE_EXAMPLE AND NOT CHAMELEON_SIMULATION) if(CHAMELEON_ENABLE_EXAMPLE AND NOT CHAMELEON_SIMULATION)
...@@ -1091,7 +1092,7 @@ set(CPACK_PACKAGE_VENDOR "Inria") ...@@ -1091,7 +1092,7 @@ set(CPACK_PACKAGE_VENDOR "Inria")
set(CPACK_PACKAGE_CONTACT "morse-devel@lists.gforge.inria.fr") set(CPACK_PACKAGE_CONTACT "morse-devel@lists.gforge.inria.fr")
set(CPACK_RESOURCE_FILE_README ${CMAKE_CURRENT_SOURCE_DIR}/README.org) set(CPACK_RESOURCE_FILE_README ${CMAKE_CURRENT_SOURCE_DIR}/README.org)
set(CPACK_RESOURCE_FILE_LICENSE ${CMAKE_CURRENT_SOURCE_DIR}/LICENCE.txt) set(CPACK_RESOURCE_FILE_LICENSE ${CMAKE_CURRENT_SOURCE_DIR}/LICENCE.txt)
set(CPACK_SOURCE_IGNORE_FILES "plasma-conversion;build;.cproject;.settings;.dir-locals.el;.project;.pydevproject;.svn;.git;.gitmodules;.gitlab-ci.yml") set(CPACK_SOURCE_IGNORE_FILES "/plasma-conversion/;/build*;.cproject;.settings;.dir-locals.el;.project;.pydevproject;/.git*")
include(CPack) include(CPack)
############################################################################### ###############################################################################
......
...@@ -7,9 +7,9 @@ ...@@ -7,9 +7,9 @@
set(CTEST_PROJECT_NAME "Chameleon") set(CTEST_PROJECT_NAME "Chameleon")
set(CTEST_NIGHTLY_START_TIME "00:00:00 GMT") set(CTEST_NIGHTLY_START_TIME "00:00:00 GMT")
set(CTEST_DROP_METHOD "http") set(CTEST_DROP_METHOD "https")
set(CTEST_DROP_SITE "cdash.inria.fr") set(CTEST_DROP_SITE "my.cdash.org")
set(CTEST_DROP_LOCATION "/CDash/submit.php?project=chameleon") set(CTEST_DROP_LOCATION "/submit.php?project=Chameleon")
set(CTEST_DROP_SITE_CDASH TRUE) set(CTEST_DROP_SITE_CDASH TRUE)
#-------------------------------------------------------------------- #--------------------------------------------------------------------
......
chameleon-1.0.0 chameleon-0.9.2
------------------------------------------------------------------------ ------------------------------------------------------------------------
- chameleon is now hosted on gitlab: https://gitlab.inria.fr/solverstack/chameleon
- MAGMA kernels are no longer supported in Chameleon - MAGMA kernels are no longer supported in Chameleon
- Add SVD/EVD drivers based on parallel first stage, and sequential LAPACK second stage and solve - Add SVD/EVD drivers based on parallel first stage, and sequential LAPACK second stage and solve
- Add First stage algorithm fo r the SVD/EVD solvers - Add First stage algorithm fo r the SVD/EVD solvers
......
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
# #
# @copyright 2009-2014 The University of Tennessee and The University of # @copyright 2009-2014 The University of Tennessee and The University of
# Tennessee Research Foundation. All rights reserved. # Tennessee Research Foundation. All rights reserved.
# @copyright 2012-2018 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria, # @copyright 2012-2019 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
# Univ. Bordeaux. All rights reserved. # Univ. Bordeaux. All rights reserved.
# @copyright 2016-2018 KAUST. All rights reserved. # @copyright 2016-2018 KAUST. All rights reserved.
# #
......
...@@ -6,8 +6,8 @@ ...@@ -6,8 +6,8 @@
# gitlab-ci pipeline badge # gitlab-ci pipeline badge
#+HTML:<a href="https://gitlab.inria.fr/solverstack/chameleon/commits/master"><img alt="pipeline status"src="https://gitlab.inria.fr/solverstack/chameleon/badges/master/pipeline.svg"/></a> #+HTML:<a href="https://gitlab.inria.fr/solverstack/chameleon/commits/master"><img alt="pipeline status"src="https://gitlab.inria.fr/solverstack/chameleon/badges/master/pipeline.svg"/></a>
# Coverity badge # # Coverity badge
#+HTML:<a href="https://scan.coverity.com/projects/chameleon"><img alt="Coverity Scan Build Status"src="https://scan.coverity.com/projects/10590/badge.svg"/></a> # #+HTML:<a href="https://scan.coverity.com/projects/chameleon"><img alt="Coverity Scan Build Status"src="https://scan.coverity.com/projects/10590/badge.svg"/></a>
Chameleon is a C library providing parallel algorithms to perform Chameleon is a C library providing parallel algorithms to perform
BLAS/LAPACK operations exploiting fully modern architectures. BLAS/LAPACK operations exploiting fully modern architectures.
......
...@@ -60,14 +60,14 @@ developers must follow and that should be read by contributors. ...@@ -60,14 +60,14 @@ developers must follow and that should be read by contributors.
Chameleon library started as an extension of the PLASMA library so Chameleon library started as an extension of the PLASMA library so
that code naming and writting conventions should follow [[https://bitbucket.org/icl/plasma][PLASMA]] ones. that code naming and writting conventions should follow [[https://bitbucket.org/icl/plasma][PLASMA]] ones.
* Packaging * Releasing
A Chameleon's release is a source package, of the form A Chameleon's release is a source package, of the form
chameleon-major.minor.patch.tar.gz, which: chameleon-major.minor.patch.tar.gz, which:
1) has been properly tested, 1) has been properly tested,
2) contains a generated documentation corresponding to the released version, 2) has an up-to-date ChangeLog file,
3) has an up-to-date ChangeLog file, 3) is published on internet as a GitLab release plus an associated
4) is published on internet. git tag.
** Test Chameleon before packaging ** Test Chameleon before packaging
...@@ -76,29 +76,29 @@ developers must follow and that should be read by contributors. ...@@ -76,29 +76,29 @@ developers must follow and that should be read by contributors.
org-mode file) to be used on PlaFRIM plus some specific ctest org-mode file) to be used on PlaFRIM plus some specific ctest
tests. tests.
** Source tarball generation ** Release generation and publication
This step requires to generate the [[sec:doc][documentation]]. Releases are published on GitLab automatically through the gitlab-ci
job /release/.
#+begin_src sh
export CHAMELEON_ROOT=/path/to/chameleon/sources/to/be/released To create a release the workflow is:
cmake $CHAMELEON_ROOT -DCHAMELEON_ENABLE_DOC=ON 1) ensure chameleon is ready for this release, /i.e./
make doc - all required features are well integrated
cp doc/orgmode/users_guide.pdf $CHAMELEON_ROOT - all tests succeed
make package_source - the ChangeLog file is up-to-date
#+end_src - the version number is up-to-date in all source files
2) create and push a branch /release-major.minor.patch/,
A tarball chameleon-major.minor.patch.tar.gz should be generated major.minor.patch being the version number for the release
and contains the users_guide documentation. 3) the gitlab-ci job should produce a new release and tag according
to the version number
** Publish the release on internet - releases: https://gitlab.inria.fr/solverstack/chameleon/releases
- tags: https://gitlab.inria.fr/solverstack/chameleon/tags
A git tag must be first created, for example 4) delete the branch
#+begin_src sh
git tag -a v1.0.0 -m 'Version 1.0.0' * CDash tests dashboard
git push --tags To see details about the tests performed during the [[https://gitlab.inria.fr/solverstack/chameleon/pipelines][pipelines]] visit
#+end_src [[https://my.cdash.org/index.php?project=Chameleon][CDash]].
Then in the Chameleon *Tags* tab, * Static and dynamic analysis
https://gitlab.inria.fr/solverstack/chameleon/tags, edit the To see details about the analysis job performed during the
release notes and attach the tarball previously generated. [[https://gitlab.inria.fr/solverstack/chameleon/pipelines][pipelines]] visit [[https://sonarqube.bordeaux.inria.fr/sonarqube/dashboard?id=hiepacs%3Achameleon%3Agitlab%3Asolverstack%3Amaster][Sonarqube]].
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
# #
# @copyright 2009-2014 The University of Tennessee and The University of # @copyright 2009-2014 The University of Tennessee and The University of
# Tennessee Research Foundation. All rights reserved. # Tennessee Research Foundation. All rights reserved.
# @copyright 2012-2018 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria, # @copyright 2012-2019 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
# Univ. Bordeaux. All rights reserved. # Univ. Bordeaux. All rights reserved.
# #
### ###
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
# Univ. of California Berkeley, # Univ. of California Berkeley,
# Univ. of Colorado Denver. # Univ. of Colorado Denver.
# #
# @version 1.0.0 # @version 0.9.2
# @author Cedric Castagnede # @author Cedric Castagnede
# @author Emmanuel Agullo # @author Emmanuel Agullo
# @author Mathieu Faverge # @author Mathieu Faverge
......
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
# #
# @copyright 2009-2014 The University of Tennessee and The University of # @copyright 2009-2014 The University of Tennessee and The University of
# Tennessee Research Foundation. All rights reserved. # Tennessee Research Foundation. All rights reserved.
# @copyright 2012-2018 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria, # @copyright 2012-2019 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
# Univ. Bordeaux. All rights reserved. # Univ. Bordeaux. All rights reserved.
# #
### ###
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
# Univ. of California Berkeley, # Univ. of California Berkeley,
# Univ. of Colorado Denver. # Univ. of Colorado Denver.
# #
# @version 1.0.0 # @version 0.9.2
# @author Florent Pruvost # @author Florent Pruvost
# @date 2014-11-10 # @date 2014-11-10
# #
......
Subproject commit 376ef84365284898e734d4d8e17359981cae8b7f Subproject commit 33a182878f9049c47af1fce3e86e72b9a10e7f7a
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
# #
# @copyright 2009-2014 The University of Tennessee and The University of # @copyright 2009-2014 The University of Tennessee and The University of
# Tennessee Research Foundation. All rights reserved. # Tennessee Research Foundation. All rights reserved.
# @copyright 2012-2018 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria, # @copyright 2012-2019 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
# Univ. Bordeaux. All rights reserved. # Univ. Bordeaux. All rights reserved.
# #
### ###
...@@ -17,11 +17,11 @@ ...@@ -17,11 +17,11 @@
# Univ. of California Berkeley, # Univ. of California Berkeley,
# Univ. of Colorado Denver. # Univ. of Colorado Denver.
# #
# @version 1.0.0 # @version 0.9.2
# @author Cedric Castagnede # @author Cedric Castagnede
# @author Emmanuel Agullo # @author Emmanuel Agullo
# @author Mathieu Faverge # @author Mathieu Faverge
# @date 2012-07-13 # @date 2014-11-16
# #
### ###
......
...@@ -2,14 +2,14 @@ ...@@ -2,14 +2,14 @@
* *
* @file map.c * @file map.c
* *
* @copyright 2018-2018 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria, * @copyright 2018-2019 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
* Univ. Bordeaux. All rights reserved. * Univ. Bordeaux. All rights reserved.
* *
*** ***
* *
* @brief Chameleon map wrappers * @brief Chameleon map wrappers
* *
* @version 1.0.0 * @version 0.9.2
* @author Mathieu Faverge * @author Mathieu Faverge
* @date 2018-09-24 * @date 2018-09-24
* *
......
...@@ -2,14 +2,14 @@ ...@@ -2,14 +2,14 @@
* *
* @file pmap.c * @file pmap.c
* *
* @copyright 2018-2018 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria, * @copyright 2018-2019 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
* Univ. Bordeaux. All rights reserved. * Univ. Bordeaux. All rights reserved.
* *
*** ***
* *
* @brief Chameleon map parallel algorithm * @brief Chameleon map parallel algorithm
* *
* @version 1.0.0 * @version 0.9.2
* @author Mathieu Faverge * @author Mathieu Faverge
* @date 2018-09-24 * @date 2018-09-24
* *
......
...@@ -4,21 +4,21 @@ ...@@ -4,21 +4,21 @@
* *
* @copyright 2009-2014 The University of Tennessee and The University of * @copyright 2009-2014 The University of Tennessee and The University of
* Tennessee Research Foundation. All rights reserved. * Tennessee Research Foundation. All rights reserved.
* @copyright 2012-2018 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria, * @copyright 2012-2019 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
* Univ. Bordeaux. All rights reserved. * Univ. Bordeaux. All rights reserved.
* *
*** ***
* *
* @brief Chameleon zbuild parallel algorithm * @brief Chameleon zbuild parallel algorithm
* *
* @version 1.0.0 * @version 0.9.2
* @comment This file has been automatically generated * @comment This file has been automatically generated
* from Plasma 2.5.0 for CHAMELEON 1.0.0 * from Plasma 2.5.0 for CHAMELEON 0.9.2
* @author Mathieu Faverge * @author Mathieu Faverge
* @author Emmanuel Agullo * @author Emmanuel Agullo
* @author Cedric Castagnede * @author Cedric Castagnede
* @author Guillaume Sylvand * @author Guillaume Sylvand
* @date 2016-09-05 * @date 2016-09-08
* @precisions normal z -> s d c * @precisions normal z -> s d c
* *
*/ */
......
...@@ -4,17 +4,17 @@ ...@@ -4,17 +4,17 @@
* *
* @copyright 2009-2014 The University of Tennessee and The University of * @copyright 2009-2014 The University of Tennessee and The University of
* Tennessee Research Foundation. All rights reserved. * Tennessee Research Foundation. All rights reserved.
* @copyright 2012-2018 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria, * @copyright 2012-2019 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
* Univ. Bordeaux. All rights reserved. * Univ. Bordeaux. All rights reserved.
* *
*** ***
* *
* @brief Chameleon zgebrd_ge2gb parallel algorithm * @brief Chameleon zgebrd_ge2gb parallel algorithm
* *
* @version 1.0.0 * @version 0.9.2
* @author Hatem Ltaief * @author Hatem Ltaief
* @author Azzam Haidar * @author Azzam Haidar
* @date 2010-11-15 * @date 2016-12-09
* @precisions normal z -> s d c * @precisions normal z -> s d c
* *
*/ */
......
...@@ -4,22 +4,22 @@ ...@@ -4,22 +4,22 @@
* *