From: vsr Date: Tue, 22 Mar 2016 08:42:24 +0000 (+0300) Subject: CoTech ACTION 79.1: revert changes in documentation about application profile X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=ca8937c5b013c50c00e30d38ae22a0ba26ef51c2;p=modules%2Fyacs.git CoTech ACTION 79.1: revert changes in documentation about application profile --- diff --git a/doc/salome/main.dox b/doc/salome/main.dox index 8dcfc33df..a0b26f7f7 100644 --- a/doc/salome/main.dox +++ b/doc/salome/main.dox @@ -16,9 +16,9 @@ introductory documentation, listed below. See \subpage SALOME_Application to define your own configuration of %SALOME and run it on one or several computers. This is the recommended way of configuration. -# How to launch %SALOME: - - Using a python launcher like the \subpage salome_command. - - Deprecated: Using the shell launchers (runAppli, runSession, runConsole...) alongside configuration files (*.cfg or *.sh), - - Deprecated: Using \c runSalome script, see \subpage running_salome_page + - Using \b NEW \subpage salome_command, based on \ref SALOME_Application. + - In a %SALOME application, see \ref SALOME_Application. + - Using \c runSalome script, see \subpage running_salome_page -# How to use KERNEL services in Python scripts\n The %SALOME KERNEL offers a list of services available in Python. See \subpage KERNEL_Services. -# How to use KERNEL services from a C++ context\n diff --git a/doc/salome/running_salome.dox b/doc/salome/running_salome.dox index 32cf2e8a7..cf1a9ab70 100644 --- a/doc/salome/running_salome.dox +++ b/doc/salome/running_salome.dox @@ -4,15 +4,11 @@ There are two ways to run %SALOME: -1) Using a python launcher. - -For more details see \ref salome_command. - -2) Deprecated : Using shell launchers. +1) Using Salome Application Concept approach. For more details see \ref SALOME_Application. -3) Deprecated : Using \c %runSalome script supplied with %SALOME KERNEL module distribution. +2) Using \c %runSalome script supplied with %SALOME KERNEL module distribution. To launch %SALOME using \c %runSalome script, you have first to set-up proper environment for %SALOME. If you installed %SALOME using diff --git a/doc/salome/salome_application.dox b/doc/salome/salome_application.dox index bd79433d9..e91b71e11 100644 --- a/doc/salome/salome_application.dox +++ b/doc/salome/salome_application.dox @@ -7,11 +7,11 @@ modules, how to define and run this application on one or more computers. \section S1_sal_appl General principles -%A %SALOME application is defined by : -- a set of modules (GEOM, SMESH, ASTER...) -- a profile: set of informatic resources (images, documentation, tests...) binding the modules together. -- a launcher: python script that creates a context (set of environment variables usable by the SALOME modules) and runs an instance of SALOME. - +%A %SALOME application is defined by a set of modules (GEOM, SMESH, ASTER...). %A %SALOME application +lives in an application directory. +%A %SALOME application is a virtual installation of %SALOME in the application directory +(bin, lib, doc, share...), with, for each file (executable, script, data, +library, resources...), symbolic links to the actual files. %A %SALOME User can define several %SALOME Applications. These applications are runnable from the same user account. These applications may share the same @@ -40,27 +40,7 @@ account@computer is via rsh or ssh and must be configured for use without password (key exchange for ssh). Account may be different on each computer. -\section S2_sal_appl Generation of a profile - -The user can generate a default profile for its application using the following command: -\code -python ${KERNEL_ROOT_DIR}/bin/salome/app-quickstart.py --prefix= --name= --modules= -\endcode - -Likely, the user would like to personalize its application's profile. Then, the profile -can be compiled using the standard cmake procedure: - -\code -cmake -make -make install -\endcode - -This profile can be used within a python launcher - like the \subpage salome_command - by setting -context variable SalomeAppConfig to the path where the profile is installed. - - -\section S3_sal_appl Deprecated Application Directory +\section S2_sal_appl Application Directory First, the user must create a %SALOME application configuration file by modifying a copy of ${KERNEL_ROOT_DIR}/bin/salome/config_appli.xml. @@ -87,7 +67,7 @@ some modules needs a special environment not defined in the above script). For a distributed application (several computers), one must copy and adapt CatalogResources.xml from ${KERNEL_ROOT_DIR}/bin/salome/appliskel (see below). -\section S4_sal_appl Deprecated general rules +\section S3_sal_appl General rules The application directory must be created on each computer of the application. The easiest way is to use the same relative path (to ${HOME}) on each computer. @@ -172,7 +152,7 @@ appliPath="my/specific/path/on/this/computer" -\section S5_sal_appl Deprecated examples of use +\section S4_sal_appl Examples of use