From: ribes <ribes>
Date: Thu, 30 Sep 2010 14:33:12 +0000 (+0000)
Subject: Work on documentation
X-Git-Tag: V6_2_0~4
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=2091610bdf92406f449c3a640e925df7f2d7f239;p=modules%2Fjobmanager.git

Work on documentation
---

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 578f572..d1d161e 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -64,7 +64,8 @@ index.rst          \
 intro.rst          \
 resource.rst       \
 job.rst            \
-jobmanager_gui.rst
+jobmanager_gui.rst \
+advanced.rst
 
 
 EXTRA_DIST+= $(RSTFILES) conf.py
diff --git a/doc/advanced.rst b/doc/advanced.rst
new file mode 100644
index 0000000..75416a1
--- /dev/null
+++ b/doc/advanced.rst
@@ -0,0 +1,52 @@
+Advanced part
+=============
+
+This chapter a melting pot of informations about what the JOBMANAGER do.
+
+Logs files
+++++++++++
+
+Whatever the type of job, the JOBMANAGER provides many files for logging
+what happens during the job. These files are located in the work directory
+of the job in a directory named log.
+
+For **command** type of job, one log file is created. This file contains the normal
+and error output of the job. The file name contains the type of job and the date, e.g. 
+**command_Thu_Sep_30_15_04_51_2010.log**.
+
+For **SALOME** type of job, two log files are create. The common file contains the 
+normal and error output of the SALOME services. The file name contains is like this:
+**salome_Wed_Feb_10_13_54_00_2010.log**. The other depends of the type of SALOME jobs:
+
+- For **Python** type of job, the file contains all the output of the scripts. The file name is
+  like this: **python_Wed_Feb_10_13_54_00_2010.log**.
+- For **YACS** type of job, the file contains all the output of the schema. The file name is
+  like this: **yacs_Wed_Feb_10_13_54_00_2010.log**.
+
+For jobs that are launch in a batch resource like PBS or LSF, two more files are provided
+that contains the normal and output messages of the PBS or LSF job. The files are like this:
+**error.log.runCommand_test_command_Wed_Sep__8_17_02_44_2010** and
+**output.log.runCommand_test_command_Wed_Sep__8_17_02_44_2010**
+
+How the JOBMANAGER launch the job
++++++++++++++++++++++++++++++++++
+
+For each type of job, the JOBMANAGER creates a shell that permits to launch in the resource
+the job file. It's in this file that the environnement file is used. For a command job
+this file is like this: **runCommand_test_command_Wed_Sep__8_16_59_08_2010.sh**.
+
+If a job has to be launched in a resource with a batch manager like PBS or LSF an another
+file is created that contains batch directives. For a command job this file is like
+this: **runCommand_test_command_Wed_Sep__8_16_59_08_2010_Batch.sh**.
+
+
+Current limitations
++++++++++++++++++++
+
+Currently, for SALOME type of jobs, the scope of the environnement file is
+restricted to the main SALOME session. Distributed containers launched in remote
+computers are not in the scope. If you want to give an environnement file to all
+your containers, use a SALOME application and copy this environnement file into the **env.d**
+directory. You also could generates into your environnement a new file into the **env.d** directory.
+
+Currently, logs files does not contain remote containers outputs.
diff --git a/doc/index.rst b/doc/index.rst
index 8d26bfa..1cf7c46 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -15,6 +15,7 @@ Welcome to JOBMANAGER's module documentation!
    job
    jobmanager_gui
    resource
+   advanced
 
 * :ref:`search`