Salome HOME
CMake:
authormpa <mpa@opencascade.com>
Thu, 14 Nov 2013 11:58:23 +0000 (11:58 +0000)
committermpa <mpa@opencascade.com>
Thu, 14 Nov 2013 11:58:23 +0000 (11:58 +0000)
- update documentation considering new CMake build system

doc/docutils/archives/INSTALL.txt
doc/docutils/archives/kernel_resources.txt
doc/docutils/salomepypkg.rst
doc/salome/install.dox
doc/salome/kernel_resources.dox

index 7c01e348cc435f5c2d994bd8203939399f4339fc..73769774d7ed7af8a73c8bb37eff82237fa69e4d 100644 (file)
@@ -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 <kernel_build>
 $ mkdir <kernel_install>
-$ cd <kernel_src>
-$ ./build_configure
 $ cd <kernel_build>
-$ <kernel_src>/configure --prefix=<kernel_install>
+$ cmake -DCMAKE_BUILD_TYPE=<Mode> -DCMAKE_INSTALL_PREFIX=<kernel_install> ../<kernel_src>
 $ make
 $ make install
 
+Where <Mode> is build mode(Release or Debug), <kernel_install> 
+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 <kernel_install>
 
 STEP 2:
-  build configure script
-
-  go to <kernel_src> directory and generate the "configure" script::
+  go to build directory
 
-    $ cd <kernel_src>
-    $ ./build_configure
-
-  If it doesn't work, check your system automake tools as specified in
-  section [2].
+    $ cd <kernel_build>
 
 STEP 3:
   configure the building process
-  go to the build directory and execute the configuration process::
-
-    $ cd <kernel_build>
-    $ <kernel_src>/configure --prefix=<kernel_install>
+    $ cmake -DCMAKE_BUILD_TYPE=<Mode> -DCMAKE_INSTALL_PREFIX=<kernel_install> ../<kernel_src>
 
+  Where <Mode> is build mode(Release or Debug), <kernel_install> 
+  is a destination folder to install KERNEL module of SALOME.
   Note that <kernel_install> 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 <kernel_build> directory::
+  Execute install target in the <kernel_install> directory::
 
     $ make install
 
@@ -285,7 +246,7 @@ STEP 5:
 
 TInstalling a component <COMPONENT> is done by following the same
 instructions as given for the KERNEL, replacing KERNEL by
-<COMPONENT> (build_configure, configure, make, make install).
+<COMPONENT>.
 
 You just have to be aware of the dependencies between components:
 
index 0bc9700da70a7b33b6e335ecca835d7b0b2f7711..c3ca235cec01eb76deb01b5536a96c48520a35d4 100644 (file)
@@ -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 
index c46063eb2955125533c4cdb04637a6d196458d7b..b3c61a6125d3a5cb4a8246697940faf5052cc5bb 100644 (file)
@@ -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
index f77b0a2e0f934a138ea9aa24757a72e53d014c13..ce7a819be5769a8208ec053d6c73ecf0926a31d7 100644 (file)
@@ -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 <kernel_build>
 $ mkdir <kernel_install>
-$ cd <kernel_src>
-$ ./build_configure
 $ cd <kernel_build>
-$ <kernel_src>/configure --prefix=<kernel_install>
+$ cmake -DCMAKE_BUILD_TYPE=<Mode> -DCMAKE_INSTALL_PREFIX=<kernel_install> ../<kernel_src>
 $ make
 $ make install
 \endcode
 
+Where <Mode> is build mode (Release or Debug), <kernel_install> 
+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 <kernel_build>
 $ mkdir <kernel_install>
 \endcode
 
-<b>STEP 2:</b>
-  build configure script
-
-  go to <kernel_src> directory and generate the "configure" script:
-
+  go to the build directory
+  
   \code
-$ cd <kernel_src>
-$ ./build_configure
+$ cd <kernel_build>
   \endcode
 
-  If it doesn't work, check your system automake tools as specified in
-  section \ref S2_install.
-
-<b>STEP 3:</b>
+<b>STEP 2:</b>
   configure the building process
-  go to the build directory and execute the configuration process:
 
   \code
-$ cd <kernel_build>
-$ <kernel_src>/configure --prefix=<kernel_install>
+$ cmake -DCMAKE_BUILD_TYPE=<Mode> -DCMAKE_INSTALL_PREFIX=<kernel_install> ../<kernel_src>
   \endcode
 
+  Where <Mode> is build mode(Release or Debug), <kernel_install> 
+  is a destination folder to install KERNEL module of SALOME.
   Note that <kernel_install> 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).
-
-
-<b>STEP 4 :</b>
+<b>STEP 3 :</b>
   Building the binary files
 
   Execute make in the <kernel_build> directory:
@@ -253,10 +212,10 @@ installed (optional for most usages).
 $ make
   \endcode
 
-<b>STEP 5:</b>
+<b>STEP 4:</b>
   Installing binary files, scripts and documentation
 
-  Execute install target in the <kernel_build> directory:
+  Execute install target in the <kernel_install> directory:
 
   \code
 $ make install
@@ -266,7 +225,7 @@ $ make install
 
 Installing a component <COMPONENT> is done by following the same
 instructions as given for the KERNEL, replacing KERNEL by
-<COMPONENT> (build_configure, configure, make, make install).
+<COMPONENT>.
 
 You just have to be aware of the dependencies between components:
 
index 1bcbead6fa61be8ff6ff351db125d5498e6ac4e8..01d39bcfbb49dad5842f038da2c9b0eea0bbfde1 100644 (file)
@@ -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