From 4343b8587936a5b16998917fa917a5cee71b12f1 Mon Sep 17 00:00:00 2001 From: mpa Date: Thu, 14 Nov 2013 11:58:23 +0000 Subject: [PATCH] CMake: - update documentation considering new CMake build system --- doc/docutils/archives/INSTALL.txt | 75 +++++-------------- doc/docutils/archives/kernel_resources.txt | 4 +- doc/docutils/salomepypkg.rst | 2 +- doc/salome/install.dox | 85 ++++++---------------- doc/salome/kernel_resources.dox | 4 +- 5 files changed, 45 insertions(+), 125 deletions(-) diff --git a/doc/docutils/archives/INSTALL.txt b/doc/docutils/archives/INSTALL.txt index 7c01e348c..73769774d 100644 --- a/doc/docutils/archives/INSTALL.txt +++ b/doc/docutils/archives/INSTALL.txt @@ -46,7 +46,7 @@ Summary First of all, you have to check (or install if needed) the dependant software programs on your system. These programs are: -- common development tools as gcc, automake, autoconf and libtools. +- common development tools as gcc, CMake tool. - third party softwares used in SALOME building or runtime process (python, OCC, VTK, ...) @@ -62,13 +62,14 @@ The next step is to install the KERNEL (cf. [5] "Installing KERNEL"): $ mkdir $ mkdir -$ cd -$ ./build_configure $ cd -$ /configure --prefix= +$ cmake -DCMAKE_BUILD_TYPE= -DCMAKE_INSTALL_PREFIX= ../ $ make $ make install +Where is build mode(Release or Debug), +is a destination folder to install KERNEL module of SALOME. + Then, the SALOME components GEOM, MED, VISU, ... can be installed with a similar procedure (cf. [6]). @@ -92,13 +93,11 @@ If you have another platform, we suggest the following configuration for building process: - gcc-3.3.x or 3.4.x -- automake-1.7 or more (only aclocal is used) -- autoconf-2.59 -- libtool-1.5.6 +- CMake-2.8.8 or more remarks: -- This is the minimum level of automake, autoconf and libtool, if you need +- This is the minimum level of CMake, if you need to compile all the third party softwares (included OpenCascade 5.2.x). 3. Third-party dependencies @@ -206,64 +205,26 @@ STEP 1: $ mkdir STEP 2: - build configure script - - go to directory and generate the "configure" script:: + go to build directory - $ cd - $ ./build_configure - - If it doesn't work, check your system automake tools as specified in - section [2]. + $ cd STEP 3: configure the building process - go to the build directory and execute the configuration process:: - - $ cd - $ /configure --prefix= + $ cmake -DCMAKE_BUILD_TYPE= -DCMAKE_INSTALL_PREFIX= ../ + Where is build mode(Release or Debug), + is a destination folder to install KERNEL module of SALOME. Note that must be an absolute path. - When the configure process is complete, check the status of - third-party softwares detection. You should have a status like:: - - --------------------------------------------- - Summary - --------------------------------------------- - Configure - cc : yes - boost : yes - lex_yacc : yes - python : yes - swig : yes - threads : yes - OpenGL : yes - qt : yes - vtk : yes - hdf5 : yes - med2 : yes - omniORB : yes - occ : yes - sip : yes - pyqt : yes - qwt : yes - doxygen : yes - graphviz : no - openpbs : no - lsf : no - Default ORB : omniORB - ---------------------------------------------- - -If a software get a status "no", then it's not "seen" in the system: + When the configure process is complete, check the status of cmake build. + You should not have the errors and warnings. All included products and packages must be found. + + If a software get a status "not found", then it's not "seen" in the system: - the software is not installed, or - the shell environment is not set correctly. -In this example, the software programs graphviz, openpbs and lsf are not -installed (optional for most usages). - - STEP 4 : Building the binary files @@ -275,7 +236,7 @@ STEP 4 : STEP 5: Installing binary files, scripts and documentation - Execute install target in the directory:: + Execute install target in the directory:: $ make install @@ -285,7 +246,7 @@ STEP 5: TInstalling a component is done by following the same instructions as given for the KERNEL, replacing KERNEL by - (build_configure, configure, make, make install). +. You just have to be aware of the dependencies between components: diff --git a/doc/docutils/archives/kernel_resources.txt b/doc/docutils/archives/kernel_resources.txt index 0bc9700da..c3ca235ce 100644 --- a/doc/docutils/archives/kernel_resources.txt +++ b/doc/docutils/archives/kernel_resources.txt @@ -82,9 +82,9 @@ This file must be included in C++ source. Some macros are activated only in debug mode, others are always activated. To activate the debug mode, ``_DEBUG_`` must be defined, which is the case when SALOME -Makefiles are generated from configure, without +Makefiles are generated from CMakeLists.txt, without options. When ``_DEBUG_`` is undefined (release mode: -``configure --disable-debug --enable-production``), the +``cmake -DCMAKE_BUILD_TYPE=Release ../KERNEL_SRC``), the debug mode macros are defined empty (they do nothing). So, when switching from debug to release, it is possible (and recommended) to let the macro calls diff --git a/doc/docutils/salomepypkg.rst b/doc/docutils/salomepypkg.rst index c46063eb2..b3c61a612 100644 --- a/doc/docutils/salomepypkg.rst +++ b/doc/docutils/salomepypkg.rst @@ -169,7 +169,7 @@ Considering the elements described above, a procedure that works to get the packaged python structure is: * Rename the file ``salome.py`` in ``__init__.py`` (and adapt the - Makefile.am). This is located in the source directory + CMakeLists.txt). This is located in the source directory ``src/KERNEL_PY``. * Copy the sources files of the kernel part in the source directory ``src/KERNEL_PY`` starting with a stage named ``kernel`` including diff --git a/doc/salome/install.dox b/doc/salome/install.dox index f77b0a2e0..ce7a819be 100644 --- a/doc/salome/install.dox +++ b/doc/salome/install.dox @@ -21,7 +21,7 @@ You'll find here generic instructions for installing the SALOME platform. First of all, you have to check (or install if needed) the dependant software programs on your system. These programs are: -- common development tools as gcc, automake, autoconf and libtools. +- common development tools as gcc, CMake tool. - third party softwares used in %SALOME building or runtime process (python, OCC, VTK, ...) @@ -36,14 +36,15 @@ The next step is to install the KERNEL (cf. \ref S5_install): \code $ mkdir $ mkdir -$ cd -$ ./build_configure $ cd -$ /configure --prefix= +$ cmake -DCMAKE_BUILD_TYPE= -DCMAKE_INSTALL_PREFIX= ../ $ make $ make install \endcode +Where is build mode (Release or Debug), +is a destination folder to install KERNEL module of SALOME. + Then, the %SALOME components GEOM, MED, VISU, ... can be installed with a similar procedure (cf. \ref S6_install). @@ -66,13 +67,11 @@ If you have another platform, we suggest the following configuration for building process: - gcc-3.3.x or 3.4.x -- automake-1.7 or more (only aclocal is used) -- autoconf-2.59 -- libtool-1.5.6 +- CMake-2.8.8 or more remarks: -- This is the minimum level of automake, autoconf and libtool, if you need +- This is the minimum level of CMake, if you need to compile all the third party softwares (included OpenCascade 5.2.x). \section S3_install Third-party dependencies @@ -179,72 +178,32 @@ $ mkdir $ mkdir \endcode -STEP 2: - build configure script - - go to directory and generate the "configure" script: - + go to the build directory + \code -$ cd -$ ./build_configure +$ cd \endcode - If it doesn't work, check your system automake tools as specified in - section \ref S2_install. - -STEP 3: +STEP 2: configure the building process - go to the build directory and execute the configuration process: \code -$ cd -$ /configure --prefix= +$ cmake -DCMAKE_BUILD_TYPE= -DCMAKE_INSTALL_PREFIX= ../ \endcode + Where is build mode(Release or Debug), + is a destination folder to install KERNEL module of SALOME. Note that must be an absolute path. - When the configure process is complete, check the status of - third-party softwares detection. You should have a status like: - - \code - --------------------------------------------- - Summary - --------------------------------------------- - Configure - cc : yes - boost : yes - lex_yacc : yes - python : yes - swig : yes - threads : yes - OpenGL : yes - qt : yes - vtk : yes - hdf5 : yes - med2 : yes - omniORB : yes - occ : yes - sip : yes - pyqt : yes - qwt : yes - doxygen : yes - graphviz : no - openpbs : no - lsf : no - Default ORB : omniORB - ---------------------------------------------- - \endcode - -If a software get a status "no", then it's not "seen" in the system: + When the configure process is complete, check the status of cmake build. + You should not have the errors and warnings. All dependent products and packages must be found. + + If a software get a status "not found", then it is not "seen" in the system: - the software is not installed, or - the shell environment is not set correctly. -In this example, the software programs graphviz, openpbs and lsf are not -installed (optional for most usages). - - -STEP 4 : +STEP 3 : Building the binary files Execute make in the directory: @@ -253,10 +212,10 @@ installed (optional for most usages). $ make \endcode -STEP 5: +STEP 4: Installing binary files, scripts and documentation - Execute install target in the directory: + Execute install target in the directory: \code $ make install @@ -266,7 +225,7 @@ $ make install Installing a component is done by following the same instructions as given for the KERNEL, replacing KERNEL by - (build_configure, configure, make, make install). +. You just have to be aware of the dependencies between components: diff --git a/doc/salome/kernel_resources.dox b/doc/salome/kernel_resources.dox index 1bcbead6f..01d39bcfb 100644 --- a/doc/salome/kernel_resources.dox +++ b/doc/salome/kernel_resources.dox @@ -58,9 +58,9 @@ This file must be included in C++ source. Some macros are activated only in debug mode, others are always activated. To activate the debug mode, _DEBUG_ must be defined, which is the case when %SALOME -Makefiles are generated from configure, without +Makefiles are generated from CMake build system, without options. When _DEBUG_ is undefined (release mode: -configure --disable-debug --enable-production), the +cmake -DCMAKE_BUILD_TYPE=Release ../KERNEL_SRC), the debug mode macros are defined empty (they do nothing). So, when switching from debug to release, it is possible (and recommended) to let the macro calls -- 2.39.2