From 8f8ed82cda689e2318aac14336129517c3b16507 Mon Sep 17 00:00:00 2001 From: boulant Date: Fri, 18 Nov 2005 18:40:52 +0000 Subject: [PATCH] =?utf8?q?Epuration=20des=20=C3=A9l=C3=A9ments=20obsol?= =?utf8?q?=C3=A8tes=20apr=C3=A8s=20analyse=20de=20la=20proc=C3=A9dure=20de?= =?utf8?q?=20construction.?= MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit --- .../configure.in.base | 0 make_config.in => DEPRECATED/make_config.in | 0 clean_configure | 14 + configure.ac | 473 ++++++++++++++++++ doc/index.txt | 56 +++ doc/rst.css | 288 +++++++++++ doc/txt2html.sh | 36 ++ doc/userguide.txt | 125 +++++ salome_adm/unix/{ => DEPRECATED}/Doxyfile | 0 .../unix/{ => DEPRECATED}/F77config.h.in | 0 salome_adm/unix/{ => DEPRECATED}/config.h.in | 0 salome_adm/unix/{ => DEPRECATED}/envScript.in | 0 salome_adm/unix/{ => DEPRECATED}/sstream.in | 0 .../{ => DEPRECATED}/ac_cc_warnings.m4 | 0 .../{ => DEPRECATED}/ac_cxx_bool.m4 | 0 .../{ => DEPRECATED}/ac_cxx_mutable.m4 | 0 .../ac_cxx_partial_specialization.m4 | 0 .../{ => DEPRECATED}/ac_cxx_typename.m4 | 0 .../{ => DEPRECATED}/check_Salome.m4 | 0 .../{ => DEPRECATED}/check_java.m4 | 0 .../{ => DEPRECATED}/check_mico.m4 | 0 21 files changed, 992 insertions(+) rename configure.in.base => DEPRECATED/configure.in.base (100%) rename make_config.in => DEPRECATED/make_config.in (100%) create mode 100755 clean_configure create mode 100644 configure.ac create mode 100644 doc/index.txt create mode 100644 doc/rst.css create mode 100755 doc/txt2html.sh create mode 100644 doc/userguide.txt rename salome_adm/unix/{ => DEPRECATED}/Doxyfile (100%) rename salome_adm/unix/{ => DEPRECATED}/F77config.h.in (100%) rename salome_adm/unix/{ => DEPRECATED}/config.h.in (100%) rename salome_adm/unix/{ => DEPRECATED}/envScript.in (100%) rename salome_adm/unix/{ => DEPRECATED}/sstream.in (100%) rename salome_adm/unix/config_files/{ => DEPRECATED}/ac_cc_warnings.m4 (100%) rename salome_adm/unix/config_files/{ => DEPRECATED}/ac_cxx_bool.m4 (100%) rename salome_adm/unix/config_files/{ => DEPRECATED}/ac_cxx_mutable.m4 (100%) rename salome_adm/unix/config_files/{ => DEPRECATED}/ac_cxx_partial_specialization.m4 (100%) rename salome_adm/unix/config_files/{ => DEPRECATED}/ac_cxx_typename.m4 (100%) rename salome_adm/unix/config_files/{ => DEPRECATED}/check_Salome.m4 (100%) rename salome_adm/unix/config_files/{ => DEPRECATED}/check_java.m4 (100%) rename salome_adm/unix/config_files/{ => DEPRECATED}/check_mico.m4 (100%) diff --git a/configure.in.base b/DEPRECATED/configure.in.base similarity index 100% rename from configure.in.base rename to DEPRECATED/configure.in.base diff --git a/make_config.in b/DEPRECATED/make_config.in similarity index 100% rename from make_config.in rename to DEPRECATED/make_config.in diff --git a/clean_configure b/clean_configure new file mode 100755 index 000000000..fa537bc92 --- /dev/null +++ b/clean_configure @@ -0,0 +1,14 @@ +#!/bin/sh + +rm -rf autom4te.cache aclocal.m4 configure make_config +rm -f *~ +exit + +here=`pwd` +libdir=salome_adm/unix/config_files +#cd $libdir +# Files created by libtoolize +#rm -f config.guess config.sub ltmain.sh +# Files created by automake +#rm -rf install-sh missing +#cd $here diff --git a/configure.ac b/configure.ac new file mode 100644 index 000000000..8f41f48d7 --- /dev/null +++ b/configure.ac @@ -0,0 +1,473 @@ +# +# ================================================================ +# Process this file with autoconf to produce a configure script +# ================================================================ +# +#AC_PREREQ(2.59) +AC_INIT(src) +#AM_INIT_AUTOMAKE + +# AC_CONFIG_AUX_DIR defines an alternative directory where to find the auxiliary +# scripts such as config.guess, install-sh, ... +AC_CONFIG_AUX_DIR(salome_adm/unix/config_files) +AC_CANONICAL_HOST + +PACKAGE=salome +AC_SUBST(PACKAGE) + +VERSION=3.1.0 +AC_SUBST(VERSION) + + +echo +echo --------------------------------------------- +echo Initialize source and build root directories +echo --------------------------------------------- +echo + +# +# This function return on stdout the absolute path of the filename in +# argument. Exemple: +# $ filename="../KERNEL_SRC/configure +# $ absfilename=`absolute_path $filename` +function absolute_path { + filename=$1 + here=`pwd` + apath=`dirname $filename` + cd $apath + apath=`pwd` + cd $here + echo $apath +} + +# Build directory, where the configure script is executed. +ROOT_BUILDDIR=`pwd` +# Source directory, where the configure script is located. +ROOT_SRCDIR=`absolute_path $0` + +AC_SUBST(ROOT_SRCDIR) +AC_SUBST(ROOT_BUILDDIR) + +echo +echo Source root directory : $ROOT_SRCDIR +echo Build root directory : $ROOT_BUILDDIR +echo +echo + +dnl Modification B. Secher portage sur osf +AC_CHECK_PROG(SHELL,sh) +AC_SUBST(SHELL) + +if test -z "$AR"; then + AC_CHECK_PROGS(AR,ar xar,:,$PATH) +fi +AC_SUBST(AR) + +echo +echo --------------------------------------------- +echo testing make +echo --------------------------------------------- +echo +AC_PROG_MAKE_SET +AC_PROG_INSTALL + +echo +echo --------------------------------------------- +echo Configuring production +echo --------------------------------------------- +echo +# production.m4 +AC_ENABLE_DEBUG(yes) +AC_DISABLE_PRODUCTION + +echo --------------------------------------------- +echo testing libtool +echo --------------------------------------------- + +dnl first, we set static to no! +dnl if we want it, use --enable-static +AC_ENABLE_STATIC(no) +AC_LIBTOOL_DLOPEN +AC_PROG_LIBTOOL + +# _CS_gbo_ Concerning libtool, I observe a default in the libtool +# script generated whith standard libtool.m4. The LTCONFIG_VERSION is +# not defined and then a test interrupts the execution: +# libtool: ltconfig version `' does not match ltmain.sh version +# `1.3.5'. I keep the custom libtool.m4 while solving the problem. + + +dnl Fix up the INSTALL macro if it s a relative path. We want the +dnl full-path to the binary instead. +#case "$INSTALL" in +# *install-sh*) +# INSTALL="${ROOT_SRCDIR}/salome_adm/unix/config_files/install-sh -c" +# ;; +#esac + +echo +echo --------------------------------------------- +echo testing C/C++ +echo --------------------------------------------- +echo + +cc_ok=no +AC_PROG_CC +AC_PROG_CXX +AC_CXX_WARNINGS +AC_CXX_TEMPLATE_OPTIONS +AC_DEPEND_FLAG +# AC_CC_WARNINGS([ansi]) +cc_ok=yes + +dnl Library libdl : +AC_CHECK_LIB(dl,dlopen) + +dnl Library librt : for alpha/osf +AC_CHECK_LIB(rt,nanosleep) + +dnl add library libm : +AC_CHECK_LIB(m,ceil) + +# _CS_gbo We should add all dependent libraries + +AC_CXX_USE_STD_IOSTREAM + +# _CS_gbo doit pouvoir être substitué à la macro standard. Dans cecas, +# il faut mettre à jour le Makefile.in principal et supprimer le fichier +# sstream embarqué avec SALOME (obsolète). +AC_CXX_HAVE_SSTREAM + +# Testing linker +AC_LINKER_OPTIONS + +echo +echo --------------------------------------------- +echo testing threads +echo --------------------------------------------- +echo + +ENABLE_PTHREADS + + +echo +echo --------------------------------------------- +echo BOOST Library +echo --------------------------------------------- +echo + +CHECK_BOOST + +dnl +dnl --------------------------------------------- +dnl testing MPI +dnl --------------------------------------------- +dnl + +# _CS_gbo Is there a real dependency to +CHECK_MPI + +dnl +dnl --------------------------------------------- +dnl testing sockets +dnl --------------------------------------------- +dnl + +CHECK_SOCKETS + +echo +echo --------------------------------------------- +echo Testing Batch +echo --------------------------------------------- +echo + +dnl Several batch systems (OpenPBS, LSF, ...) can be operated using +dnl the Batch classe library integrated in the KERNEL module. The +dnl checking process tests here the presence of underlying batch +dnl softwares. If none is detected, the KERNEL is declared to be +dnl "without batch". + +echo testing OpenPBS +echo --------------- +openpbs_ok=no +CHECK_OPENPBS +dnl openpbs_ok is set to yes by CHECK_OPENPBS + +echo testing LSF +echo ----------- +lsf_ok=no +CHECK_LSF +dnl lsf_ok is set to yes by CHECK_LSF +echo lsf = $lsf_ok + +WITH_BATCH=no +test x$openpbs_ok = xyes || test x$lsf_ok = xyes && WITH_BATCH=yes +AC_SUBST(WITH_BATCH) + + +echo +echo --------------------------------------------- +echo testing python +echo --------------------------------------------- +echo + +CHECK_PYTHON + +echo +echo --------------------------------------------- +echo testing swig +echo --------------------------------------------- +echo + +CHECK_SWIG + +echo +echo --------------------------------------------- +echo Configuration of the ORB +echo --------------------------------------------- +echo + +echo Testing OMNIORB ... +CHECK_OMNIORB + +echo Selecting the default ORB +DEFAULT_ORB=omniORB +echo DEFAULT_ORB : $DEFAULT_ORB +CHECK_CORBA + +CORBA_RULES=salome_adm/unix/make_$ORB +AC_SUBST_FILE(CORBA_RULES) + +# The CORBA_RULES variable defines the file name that +# implements the building rules to be included by Makefile to process +# idl files and CORBA specific dependencies (ex: the file +# salome_adm/unix/make_omniorb is the default for SALOME). The value +# of ORB is defined by CHECK_CORBA. + +# Note that this checking process is no longer relevant for SALOME +# because the possibility of changing the ORB as a plugin is probably +# deprecated. The software configuration is clearly omniorb for CORBA +# communication. This could be simplify in a near futur. + +echo +echo ---------------------------------------------- +echo testing CPPUNIT only required for unit testing +echo ---------------------------------------------- +echo + +CHECK_CPPUNIT + +echo +echo --------------------------------------------- +echo testing HDF5 +echo --------------------------------------------- +echo + +CHECK_HDF5 + +echo +echo --------------------------------------------- +echo Testing OpenCascade +echo --------------------------------------------- +echo + +CHECK_CAS + + +echo +echo --------------------------------------------- +echo Testing QT +echo --------------------------------------------- +echo +# Qt must be kept because kernel makes use of qxml and some other +# non-graphical stuff. +CHECK_QT + + +echo +echo --------------------------------------------- +echo Testing html generators +echo --------------------------------------------- +echo + +CHECK_HTML_GENERATORS + +echo +echo --------------------------------------------- +echo Summary +echo --------------------------------------------- +echo + +# This function displays the values of each variable given in arguments +function summary { + variables=$* + for var in $variables + do + eval toto=\$$var + if test x$toto != "x"; then + printf " %10s : " `echo \$var | sed -e "s,_ok,,"` + eval echo \$$var + fi + done +} + +function check_fatal_error { + variables=$* + for var in $variables + do + eval toto=\$$var + if test x$toto != "xyes"; then + echo "FATAL ERROR: some mandatory products are missing." + echo "Installing the missing products is required before running the configure script". + exit 1 + fi + done +} + +echo Configure +echo + +mandatory_products="cc_ok boost_ok python_ok swig_ok threads_ok hdf5_ok omniORB_ok occ_ok qt_ok" +echo --- Mandatory products: +summary $mandatory_products +check_fatal_error $mandatory_products +echo + +htmldoc_products="doxygen_ok graphviz_ok rst2html_ok" +echo --- Html documentation products: +summary $htmldoc_products +echo + +optional_products="mpi_ok cppunit_ok openpbs_ok lsf_ok" +echo --- Optional products: +echo These products are optional because the KERNEL functions using them are built +echo only if the products are detected. +summary $optional_products +echo + +echo +echo "Default ORB : $DEFAULT_ORB" +echo + +dnl generals files which could be included in every makefile + +AC_SUBST_FILE(COMMENCE) COMMENCE=salome_adm/unix/make_commence +AC_SUBST_FILE(CONCLUDE) CONCLUDE=salome_adm/unix/make_conclude +AC_SUBST_FILE(MODULE) MODULE=salome_adm/unix/make_module + +dnl les dependences +AC_SUBST_FILE(DEPEND) DEPEND=salome_adm/unix/depend + +dnl We don t need to say when we re entering directories if we re using +dnl GNU make becuase make does it for us. +if test "X$GMAKE" = "Xyes"; then + AC_SUBST(SETX) SETX=":" +else + AC_SUBST(SETX) SETX="set -x" +fi + +# make other build directories +for rep in salome_adm adm_local doc bin/salome include/salome lib/salome share/salome/resources idl +do + $INSTALL -d $rep +done + +echo +echo --------------------------------------------- +echo copying resource files, shell scripts, and +echo xml files +echo --------------------------------------------- +echo + + +mkdir -p bin/salome +cd bin/salome +for i in `find $ROOT_SRCDIR/bin` +do + local_bin=`echo $i | sed -e "s,$ROOT_SRCDIR/bin,.,"` + case "$local_bin" in + *.in | *~) ;; + . | */CVS | */CVS/* | ./salome) ;; + ./appliskel |./appliskel/env.d) $INSTALL -d $local_bin ; echo $local_bin ;; + *) $INSTALL $i $local_bin; echo $local_bin ;; + esac +done +cd $ROOT_BUILDDIR + +AC_SUBST_FILE(ENVSCRIPT) ENVSCRIPT=salome_adm/unix/envScript + +echo +echo --------------------------------------------- +echo generating Makefiles and configure files +echo --------------------------------------------- +echo + +AC_OUTPUT_COMMANDS([ \ + chmod +x ./bin/*; \ + chmod +x ./bin/salome/* \ +]) + +# This list is initiated using autoscan and must be updated manually +# when adding a new file .in to manage. When you execute +# autoscan, the Makefile list is generated in the output file configure.scan. +# This could be helpfull to update de configuration. +AC_OUTPUT([ \ + ./salome_adm/unix/SALOMEconfig.h \ + ./salome_adm/unix/depend \ + ./salome_adm/unix/make_omniorb \ + ./salome_adm/unix/make_commence \ + ./salome_adm/unix/make_conclude \ + ./salome_adm/unix/make_module \ + ./salome_adm/Makefile \ + ./Makefile \ + ./bin/salome/runIDLparser \ + ./doc/Makefile \ + ./doc/salome/Makefile \ + ./doc/salome/DevelopersGuide/DevelopersGuide.tex \ + ./doc/salome/DevelopersGuide/Makefile \ + ./doc/salome/gui/Makefile \ + ./doc/salome/tui/Makefile \ + ./idl/Makefile \ + ./resources/Plugin \ + ./src/Makefile \ + ./src/Basics/Makefile \ + ./src/Basics/Test/Makefile \ + ./src/Batch/Makefile \ + ./src/Batch_SWIG/Makefile \ + ./src/CASCatch/Makefile \ + ./src/Communication/Makefile \ + ./src/Container/Makefile \ + ./src/DataTypeCatalog/Makefile \ + ./src/GenericObj/Makefile \ + ./src/HDFPersist/Makefile \ + ./src/KERNEL_PY/Makefile \ + ./src/LifeCycleCORBA/Makefile \ + ./src/LifeCycleCORBA/Test/Makefile \ + ./src/LifeCycleCORBA_SWIG/Makefile \ + ./src/Logger/Makefile \ + ./src/Logger/Test/Makefile \ + ./src/ModuleCatalog/Makefile \ + ./src/ModuleGenerator/Makefile \ + ./src/ModuleGenerator/testIDLparser \ + ./src/MPIContainer/Makefile \ + ./src/NamingService/Makefile \ + ./src/Notification/Makefile \ + ./src/NOTIFICATION_SWIG/Makefile \ + ./src/Registry/Makefile \ + ./src/ResourcesManager/Makefile \ + ./src/RessourcesCatalog/Makefile \ + ./src/SALOMEDS/Makefile \ + ./src/SALOMEDSClient/Makefile \ + ./src/SALOMEDSImpl/Makefile \ + ./src/SALOMELocalTrace/Makefile \ + ./src/SALOMELocalTrace/Test/Makefile \ + ./src/SALOMETraceCollector/Makefile \ + ./src/SALOMETraceCollector/Test/Makefile \ + ./src/TestContainer/Makefile \ + ./src/TestMPIContainer/Makefile \ + ./src/TOOLSDS/Makefile \ + ./src/UnitTests/Makefile \ + ./src/Utils/Makefile \ + ./src/Utils/Test/Makefile \ +]) + diff --git a/doc/index.txt b/doc/index.txt new file mode 100644 index 000000000..7d23c5161 --- /dev/null +++ b/doc/index.txt @@ -0,0 +1,56 @@ + +================================================================= +General information, for developpers and users +================================================================= + +.. contents:: +.. sectnum:: + + +*html version of this document is produced with docutils*:: + + rst2html < doc.txt > doc.html + +This document corresponds to SALOME2 3.1. (alpha version) + ++-------------------------------------------+ +| **WORK in PROGRESS, INCOMPLETE DOCUMENT** | ++-------------------------------------------+ + +How to install SALOME +--------------------- + +See INSTALL_ for general information on required configuration and +prerequisites, compilation procedure, setting environment principles. + +.. _INSTALL: ./INSTALL.html + +How to run SALOME on one or more computers, SALOME Application concept +---------------------------------------------------------------------- + +See SALOME_Application_ to define your own configuration of SALOME and run it +on one or several computers. This is the recommended way of configuration. + +.. _SALOME_Application: ./SALOME_Application.html + + +Source code structuration and Unit Tests +---------------------------------------- + +See UnitTests_ for general information on code directories structure, +unit tests associated to the different kind of classes, and how to run +the unit tests. + +.. _UnitTests: ./UnitTests.html + +End User documentation +---------------------- + +link to end user documentation. + + +Developper documentation +------------------------ + +See `userguide `_ to get basic concepts on for developing and +using the SALOME platform diff --git a/doc/rst.css b/doc/rst.css new file mode 100644 index 000000000..eb02941b5 --- /dev/null +++ b/doc/rst.css @@ -0,0 +1,288 @@ +/* +:Authors: David Goodger, David Abrahams +:Contact: goodger@users.sourceforge.net, dave@boost-consulting.com +:date: $Date$ +:version: $Revision$ +:copyright: This stylesheet has been placed in the public domain. + +This stylesheet is for the use of ReStructuredText in a Boost context. +It is basically an agglomeration of boost.css and the default.css that +comes from docutils. + + */ + +.first { + margin-top: 0 } + +.last { + margin-bottom: 0 } + +a.toc-backref { + text-decoration: none ; + color: #00008B } + +dd { + margin-bottom: 0.5em } + +div.abstract { + margin: 2em 5em } + +div.abstract p.topic-title { + font-weight: bold ; + text-align: center } + +div.attention, div.caution, div.danger, div.error, div.hint, +div.important, div.note, div.tip, div.warning, div.admonition { + margin: 2em ; + border: medium outset ; + padding: 1em } + +div.attention p.admonition-title, div.caution p.admonition-title, +div.danger p.admonition-title, div.error p.admonition-title, +div.warning p.admonition-title { + color: red ; + font-weight: bold ; + font-family: sans-serif } + +div.hint p.admonition-title, div.important p.admonition-title, +div.note p.admonition-title, div.tip p.admonition-title, +div.admonition p.admonition-title { + font-weight: bold ; + font-family: sans-serif } + +div.dedication { + margin: 2em 5em ; + text-align: center ; + font-style: italic } + +div.dedication p.topic-title { + font-weight: bold ; + font-style: normal } + +div.figure { + margin-left: 2em } + +div.footer, div.header { + font-size: smaller } + +div.sidebar { + margin-left: 1em ; + border: medium outset ; + padding: 0em 1em ; + background-color: #ffffee ; + width: 40% ; + float: right ; + clear: right } + +div.sidebar p.rubric { + font-family: sans-serif ; + font-size: medium } + +div.system-messages { + margin: 5em } + +div.system-messages h1 { + color: red } + +div.system-message { + border: medium outset ; + padding: 1em } + +div.system-message p.system-message-title { + color: red ; + font-weight: bold } + +div.topic { + margin: 2em } + +H1.title +{ + FONT-SIZE: 200%; + COLOR: #00008B; + text-align: center +} +H1 +{ + FONT-SIZE: 150%; +} +H2 +{ + FONT-SIZE: 125%; +} +h2.subtitle { + text-align: center } +H3 +{ + FONT-SIZE: 108%; +} +BODY +{ + FONT-SIZE: 100%; + BACKGROUND-COLOR: #ffffff; +} +PRE +{ + MARGIN-LEFT: 2em; + FONT-FAMILY: Courier; +} +CODE +{ + FONT-FAMILY: Courier; + white-space: pre; +} +.pre +{ + FONT-FAMILY: Courier; + white-space: pre; +} +.index +{ + TEXT-ALIGN: left; +} +.page-index +{ + TEXT-ALIGN: left; +} +.definition +{ + TEXT-ALIGN: left; +} +.footnote +{ + FONT-SIZE: 66%; + VERTICAL-ALIGN: super; + TEXT-DECORATION: none; +} +.function-semantics +{ + CLEAR: left; +} + +hr { + width: 75% } + +ol.simple, ul.simple { + margin-bottom: 1em } + +ol.arabic { + list-style: decimal } + +ol.loweralpha { + list-style: lower-alpha } + +ol.upperalpha { + list-style: upper-alpha } + +ol.lowerroman { + list-style: lower-roman } + +ol.upperroman { + list-style: upper-roman } + +p.attribution { + text-align: right ; + margin-left: 50% } + +p.caption { + font-style: italic } + +p.credits { + font-style: italic ; + font-size: smaller } + +p.label { + white-space: nowrap } + +p.rubric { + font-weight: bold ; + font-size: larger ; + color: maroon ; + text-align: center } + +p.sidebar-title { + font-family: sans-serif ; + font-weight: bold ; + font-size: larger } + +p.sidebar-subtitle { + font-family: sans-serif ; + font-weight: bold } + +p.topic-title { + font-weight: bold } + +pre.address { + margin-bottom: 0 ; + margin-top: 0 ; + font-family: serif ; + font-size: 100% } + +pre.line-block { + font-family: serif ; + font-size: 100% } + +pre.literal-block, pre.doctest-block { + margin-left: 2em ; + margin-right: 2em ; + font-size: 80%; + border: solid thin gray ; + background-color: #eeeeee } + +span.classifier { + font-family: sans-serif ; + font-style: oblique } + +span.classifier-delimiter { + font-family: sans-serif ; + font-weight: bold } + +span.interpreted { + font-family: sans-serif } + +span.option { + white-space: nowrap } + +span.option-argument { + font-style: italic } + +span.pre { + white-space: pre } + +span.problematic { + color: red } + +table { + margin-top: 0.5em ; + margin-bottom: 0.5em } + +table.citation { + border-left: solid thin gray ; + padding-left: 0.5ex } + +table.docinfo { + margin: 2em 4em } + +table.footnote { + border-left: solid thin black ; + padding-left: 0.5ex } + +td, th { + padding-left: 0.5em ; + padding-right: 0.5em ; + vertical-align: top } + +th.docinfo-name, th.field-name { + font-weight: bold ; + text-align: left ; + white-space: nowrap } + +/* + dwa 2003/7/29 -- commented out so that it wouldn't override earlier + styles from boost.css + +h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { + font-size: 100% } +*/ + +ul.auto-toc { + list-style-type: none } diff --git a/doc/txt2html.sh b/doc/txt2html.sh new file mode 100755 index 000000000..777f1a302 --- /dev/null +++ b/doc/txt2html.sh @@ -0,0 +1,36 @@ +#/bin/sh +# =================================================================== +# This shell script is provided for generating the html files +# from the txt files (restructured text) in the source directory. +# +# Usage: just execute the script where it stands in the source +# directory. The file list has to be updated manually when adding +# a new restructured text file. +# +# Note that the building process executes a target rstdoc that +# generates the html documentation without need of this script. +# The autoconficuration (check_htmlgen.m4) set the correct generator +# rst2html by replacing the @RST2HTML@ tag. +# =================================================================== +# (CSSI - gboulant - 25/10/05) +# + +# This must be updated manually in this script (for source usage only) +RST2HTML=rst2html + +FILELIST="\ + index \ + UnitTests \ + SALOME_Application \ + INSTALL\ + userguide" + +STYLESHEET=rst.css +RSTOPTS="--output-encoding=latin1 --stylesheet=$STYLESHEET" + +for file in $FILELIST; do + bfn=`basename $file .txt` + echo "Generating ${bfn}.html from ${bfn}.txt ..." + $RST2HTML $RSTOPTS ${bfn}.txt ${bfn}.html +done + diff --git a/doc/userguide.txt b/doc/userguide.txt new file mode 100644 index 000000000..96bbfb6b0 --- /dev/null +++ b/doc/userguide.txt @@ -0,0 +1,125 @@ + +================================================================= +User's guide, for developpers and users +================================================================= + +.. contents:: +.. sectnum:: + +This guide provides you with some basic concepts for developing and +using the SALOME platform. You will find some information on the +general technical architecture ... + +Introduction +============ + +General information +------------------- + +This document has been initialized by collecting and updating an existing +documentation. The restructured text format has been selected for +writing. This format can be read with a basic editor except for +pictures and some hypertext links. You can build the html pages using +the docutils scripts provided with python packages on most platform. + +Definitions +----------- + +``WORK IN PROGRESS`` + +Module + definition of a module and/or link to the definition + +Container + definition of a container + + +General concepts +================ +modules et dépendances (s'inspirer de PYHELLO) + + +Filesystem organisation +======================== + +Voir doc de JR "Organisation de la plate-forme" + +A typical source working directory +---------------------------------- +organisation type des sources d'un module standard (spécifications techniques) + +A typical installation directory +-------------------------------- +organisation type des produits installés + + +Building process +================ +Procédures de compilation (renvoie au install.sh) + + +Developer's guide - basic concepts +========================================= + +Guide du développeur: éléments de conception + - zoom sur certains éléments techniques bons à connaitre pour faire + évoluer le KERNEL sans tout casser. + - les ressources du kernel: + - trace, debug, exception (cf. kernel_ressources.tex) + - classes batch (présentation puis renvoi à la doc d'Ivan) + - développement de tests unitaires + +Developer's guide - managing the development space +================================================== + +- Guide du développeur: gestion de l'espace de développement + - principe de mise en oeuvre (rôle des étapes: build_configure, ...) + - description des fichiers m4 et du principe de mise en oeuvre + - les Makefile.in, ... (cf. doc guide du développeur). + - évolution des procédures de construction + - personalisation des procédures de construction + +Developer' guide - integration tools +==================================== +- Guide de l'intégrateur (développeur de nouveaux modules) +(on lui montre ici le principe de construction et les ressources à +disposition pour faire le travail) + - création d'un modules + - intégration code boîte noire (perfect, solver) + - intégration bibliothèque de fonctions (hxx2salome, voir avec + N.Crouzet) + - intégration de modèles de données (xdata) + + +End user's guide +================ +- Guide de l'utilisateur + - concept d'application (renvoie doc Paul) + - commandes avancées (showNS, exemple de contact de la + session, d'un engine, utilisation du lifeCycle, du module salome, + des modules geompy et smesh) + - utilisation en mode distribué (doc de B. Sechet) + - GUI and TUI documentation + + + + + + + + + + + + + + + +RST Exemples +============ + +See INSTALL_ for general information on required configuration and +prerequisites, compilation procedure, setting environment principles. + +.. _INSTALL: ./INSTALL.html + diff --git a/salome_adm/unix/Doxyfile b/salome_adm/unix/DEPRECATED/Doxyfile similarity index 100% rename from salome_adm/unix/Doxyfile rename to salome_adm/unix/DEPRECATED/Doxyfile diff --git a/salome_adm/unix/F77config.h.in b/salome_adm/unix/DEPRECATED/F77config.h.in similarity index 100% rename from salome_adm/unix/F77config.h.in rename to salome_adm/unix/DEPRECATED/F77config.h.in diff --git a/salome_adm/unix/config.h.in b/salome_adm/unix/DEPRECATED/config.h.in similarity index 100% rename from salome_adm/unix/config.h.in rename to salome_adm/unix/DEPRECATED/config.h.in diff --git a/salome_adm/unix/envScript.in b/salome_adm/unix/DEPRECATED/envScript.in similarity index 100% rename from salome_adm/unix/envScript.in rename to salome_adm/unix/DEPRECATED/envScript.in diff --git a/salome_adm/unix/sstream.in b/salome_adm/unix/DEPRECATED/sstream.in similarity index 100% rename from salome_adm/unix/sstream.in rename to salome_adm/unix/DEPRECATED/sstream.in diff --git a/salome_adm/unix/config_files/ac_cc_warnings.m4 b/salome_adm/unix/config_files/DEPRECATED/ac_cc_warnings.m4 similarity index 100% rename from salome_adm/unix/config_files/ac_cc_warnings.m4 rename to salome_adm/unix/config_files/DEPRECATED/ac_cc_warnings.m4 diff --git a/salome_adm/unix/config_files/ac_cxx_bool.m4 b/salome_adm/unix/config_files/DEPRECATED/ac_cxx_bool.m4 similarity index 100% rename from salome_adm/unix/config_files/ac_cxx_bool.m4 rename to salome_adm/unix/config_files/DEPRECATED/ac_cxx_bool.m4 diff --git a/salome_adm/unix/config_files/ac_cxx_mutable.m4 b/salome_adm/unix/config_files/DEPRECATED/ac_cxx_mutable.m4 similarity index 100% rename from salome_adm/unix/config_files/ac_cxx_mutable.m4 rename to salome_adm/unix/config_files/DEPRECATED/ac_cxx_mutable.m4 diff --git a/salome_adm/unix/config_files/ac_cxx_partial_specialization.m4 b/salome_adm/unix/config_files/DEPRECATED/ac_cxx_partial_specialization.m4 similarity index 100% rename from salome_adm/unix/config_files/ac_cxx_partial_specialization.m4 rename to salome_adm/unix/config_files/DEPRECATED/ac_cxx_partial_specialization.m4 diff --git a/salome_adm/unix/config_files/ac_cxx_typename.m4 b/salome_adm/unix/config_files/DEPRECATED/ac_cxx_typename.m4 similarity index 100% rename from salome_adm/unix/config_files/ac_cxx_typename.m4 rename to salome_adm/unix/config_files/DEPRECATED/ac_cxx_typename.m4 diff --git a/salome_adm/unix/config_files/check_Salome.m4 b/salome_adm/unix/config_files/DEPRECATED/check_Salome.m4 similarity index 100% rename from salome_adm/unix/config_files/check_Salome.m4 rename to salome_adm/unix/config_files/DEPRECATED/check_Salome.m4 diff --git a/salome_adm/unix/config_files/check_java.m4 b/salome_adm/unix/config_files/DEPRECATED/check_java.m4 similarity index 100% rename from salome_adm/unix/config_files/check_java.m4 rename to salome_adm/unix/config_files/DEPRECATED/check_java.m4 diff --git a/salome_adm/unix/config_files/check_mico.m4 b/salome_adm/unix/config_files/DEPRECATED/check_mico.m4 similarity index 100% rename from salome_adm/unix/config_files/check_mico.m4 rename to salome_adm/unix/config_files/DEPRECATED/check_mico.m4 -- 2.39.2