+++ /dev/null
-# -*- coding: utf-8 -*-
-#
-# CMake build procedure documentation build configuration file, created by
-# sphinx-quickstart on Tue Jul 2 14:10:22 2013.
-#
-# This file is execfile()d with the current directory set to its containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import sys, os
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
-
-# -- General configuration -----------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = []
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'CMake build procedure'
-copyright = u'2013, Adrien Bruneton (CEA), Anthony Geay (CEA), Nicolas Geimer (EDF), Paul Rascle (EDF)'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '1.0'
-# The full version, including alpha/beta/rc tags.
-release = '1.0'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = []
-
-# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-
-# -- Options for HTML output ---------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-html_theme = 'default'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-#html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents. If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_domain_indices = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'CMakebuildproceduredoc'
-
-
-# -- Options for LaTeX output --------------------------------------------------
-
-latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
- ('index', 'CMakebuildprocedure.tex', u'CMake build procedure Documentation',
- u'Adrien Bruneton (CEA), Anthony Geay (CEA), Nicolas Geimer (EDF), Paul Rascle (EDF)', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output --------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
- ('index', 'cmakebuildprocedure', u'CMake build procedure Documentation',
- [u'Adrien Bruneton (CEA), Anthony Geay (CEA), Nicolas Geimer (EDF), Paul Rascle (EDF)'], 1)
-]
-
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# -- Options for Texinfo output ------------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- ('index', 'CMakebuildprocedure', u'CMake build procedure Documentation',
- u'Adrien Bruneton (CEA), Anthony Geay (CEA), Nicolas Geimer (EDF), Paul Rascle (EDF)', 'CMakebuildprocedure', 'One line description of project.',
- 'Miscellaneous'),
-]
-
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+++ /dev/null
-Introduction
-============
-CMake is a configuration tool generating the build chain (e.g. Makefiles on Linux)
-of a software project.
-This documentation describes the goals and the good practices to be applied when writing
-the CMake files for the configuration of a SALOME module.
-
-This documentation is best browsed with the SALOME KERNEL's sources at hand, in order to be able to
-take a look at code snipets. Most references in this document points to KERNEL sources.
-
-The section marked as ADVANCED need not be read by someone only trying to compile SALOME. Those
-sections are intented to the core SALOME developers, to help them understand/fix/improve
-the process.
-
-Motivations and overview
-========================
-
-CMake must be user-friendly
----------------------------
-
-Every beginner should be able to build SALOME, without any previous knowledge of SALOME.
-With a tool like cmake-gui or ccmake, the user must obtain useful messages to find what is wrong or missing.
-
-The general philosophy is thus to allow a developper to build SALOME with a minimal effort, setting only the
-minimal set of variables (via the command line or the environment).
-
-Basic usage
------------
-Once the sources have been retrieved (via a clone of the repository or an extraction of the tarball)
-one typically:
-
-* creates a dedicated build directory, e.g. KERNEL_BUILD.
-* switches to it, and invoke the ccmake (or cmake-gui) command::
-
- cd KERNEL_BUILD
- ccmake ../KERNEL_SRC
-
-* sets all the xyz_ROOT_DIR to point to the root paths of the package <xyz>.
-* sets the installation directory in the variable CMAKE_INSTALL_PREFIX.
-* generates the build files (hiting 'g' under ccmake).
-* invokes the make command in the usual way::
-
- make
- make install
-
-* if you see an error complaining that the package was not found, double check that the XYZ_ROOT_DIR variable was correctly set, and delete everything in your build directory before retrying::
-
- cd KERNEL_BUILD
- rm -rf *
- ccmake ../KERNEL_SRC
-
-If you want to use a specific Python installation to configure and build SALOME, you should ensure that:
-
-* the interpreter is in your path.
-* the variables LD_LIBRARY_PATH (PATH under Windows) and PYTHONPATH are properly pointing to the desired Python installation.
-
-Variable reference
-------------------
-
-The following list indicates the expected variables for each module. They can be specified on the CMake command line (with the -D flag) or in the environment.
-
-KERNEL module:
-
-* LIBBATCH_ROOT_DIR: LibBatch package - already uses Python, Swig and PThread
-* PYTHON_ROOT_DIR: Python package
-* PTHREAD_ROOT_DIR: PThread package - typically not need on Unix systems
-* SWIG_ROOT_DIR: SWIG package
-* LIBXML2_ROOT_DIR: LibXml2 package
-* HDF5_ROOT_DIR: HDF5 package - if HDF5 was compiled with MPI support, the corresponding MPI root directory will be exposed automatically (no need to set MPI_ROOT_DIR)
-* BOOST_ROOT_DIR: Boost package
-* OMNIORB_ROOT_DIR: OmniORB package
-* OMNIORBPY_ROOT_DIR: OmniORB Python backend - if not given, OMNIORB_ROOT_DIR will be tried
-* MPI_ROOT_DIR: MPI package (see HDF5_ROOT_DIR above)
-* CPPUNIT_ROOT_DIR: CppUnit package
-* DOXYGEN_ROOT_DIR: Doxygen package
-* GRAPHVIZ_ROOT_DIR: Graphviz package
-* SPHINX_ROOT_DIR: Sphinx package - requires setuptools and docutils to work properly.
-* SETUPTOOLS_ROOT_DIR: Setuptools package. This package is not detected explicitly in the KERNEL, but the path is used to complete the PYTHON path given to Sphinx.
-* DOCUTILS_ROOT_DIR: Docutils package. This package is not detected explicitly in the KERNEL, but the path is used to complete the PYTHON path given to Sphinx.
-
-GUI module - on top of some of the KERNEL prerequisites, the following variables are used:
-
-* VTK_ROOT_DIR: VTK package. If not given, PARAVIEW_ROOT_DIR is used to look for a VTK installation inside the ParaView installation
-* (optional) PARAVIEW_ROOT_DIR: see above
-* CAS_ROOT_DIR: Cascade package
-* SIP_ROOT_DIR: SIP package
-* QT4_ROOT_DIR: Qt4 package (only some components are loaded)
-* PYQT4_ROOT_DIR: PyQt4 package
-* QWT_ROOT_DIR: Qwt package
-* OPENGL_ROOT_DIR: OpenGL package
-
-MED module - on top of some of the KERNEL and GUI prerequisites, the following variables are used:
-
-* MEDFILE_ROOT_DIR: MEDFile package
-* METIS_ROOT_DIR (optional): Metis package
-* PARMETIS_ROOT_DIR (optional): ParMetis package
-* SCOTCH_ROOT_DIR (optional): Scotch package
-
-PARAVIS module - on top of some of the KERNEL, GUI and MED prerequisites, the following variables are used:
-
-* PARAVIEW_ROOT_DIR: ParaView package
-* at present for a proper build of PARAVIS, the env variables LD_LIBRARY_PATH and PYTHONPATH should be set to contain the HDF5 and ParaView libraries. This is required since the configuration process itself uses a Python script in which the environment is not overriden::
-
- # Paravis compilation needs ParaView (and hence HDF5) in the Python path:
- export PYTHONPATH=$PARAVIEW_ROOT_DIR/lib/paraview-3.98/site-packages:$PARAVIEW_ROOT_DIR/lib/paraview-3.98:$PYTHONPATH
- export LD_LIBRARY_PATH=$PARAVIEW_ROOT_DIR/lib/paraview-3.98:$HDF5_ROOT_DIR/lib:$LD_LIBRARY_PATH
-
-
-
-Overview of the logic (advanced)
---------------------------------
-
-Here are the general principles guiding the implementation:
-
-* Only taking into account the first order prerequisites of a module should be required.
- For instance, CASCADE uses Tbb :
-
- * CASCADE is a prerequisite of first order (level 1) of GUI,
- * Tbb is a prerequisite of second order (level 2) of GUI,
- * GUI CMake files must reference explicitly CASCADE, but never Tbb. The detection logic of CASCADE should make sure Tbb gets included.
-
-* Being able to use different versions/installations of the same product, in the system, or generated by the user.
- For instance, using the system python 2.7, or a user-compiled python 2.6.
-* The detection of prerequisites is driven by user options.
- For example MPI is detected only if option SALOME_USE_MPI is ON.
-* Detection of first order prerequisites is based on a <Product>_ROOT_DIR variable or on what has been detected in another dependency. For example if both HDF5 and MPI are needed by the current module, we try to detect with which MPI installation HDF5 was compiled, and to offer this one as a default choice for the package itself. Other variables (PATH, LD_LIBRARY_PATH, PYTHONPATH) should never be needed at compile time.
-* The only exception to the previous point is Python, which is so central to the process that we assume that LD_LIBRARY_PATH and PYTHONPATH are already correctly pointing to the correct Python installation.
-* Trying as much as possible to detect potential conflict, and warn the user:
-
- * if the package was detected at a place different from what was specified in XYZ_ROOT_DIR
- * if there is a conflict between what was explicitly set in XYZ_ROOT_DIR, and what was previously used in a dependency
-
-
-
