Changes between Version 4 and Version 5 of DocDéveloppeur

Timestamp:

07/24/08 18:41:36 (16 years ago)

Author:

sdipsl

Comment:

--

DocDéveloppeur

@@ -238 +238 @@
 #==================================================================
 function IGCM_debug_Exit
-* Purpose: Print Call Stack and exit with number 1
+* Purpose: Print Call Stack and set ExitFlag to true
+
+#==================================================
+function IGCM_debug_Verif_Exit
+* Purpose: exit with number 1 if ExitFlag is true
+
+#==================================================
+function IGCM_debug_Verif_Exit_Post
+* Purpose: exit with number 1 if ExitFlag is true for Post-treatment
 
 #==================================================================
@@ -256 +264 @@
 
 = libIGCM_sys =
+{{{
+#==================================================
+LibIGCM_sys for Mercure
+#==================================================
+
+ This ksh library if a layer under some usefull 
+environment variables and shell commands.
+All those definitions depend on host particularities.
+It manages a stack mechanism and test validity of operations.
+All function described bellow must be prefixed by IGCM_sys.
+
+#==================================================
+Program used in libIGCM
+#==================================================
+#==================================================
+function IGCM_sys_RshPost
+* Purpose: Master rsh command
+* Examples:
+
+#==================================================
+function IGCM_sys_Mkdir
+* Purpose: Master locale mkdir command
+* Examples:
+
+#==================================================
+function IGCM_sys_MkdirArchive
+* Purpose: Mkdir on Archive
+* Examples:
+
+#==================================================
+function IGCM_sys_MkdirWork
+* Purpose: Mkdir on Work
+* Examples:
+
+#==================================================
+function IGCM_sys_Cd
+* Purpose: master cd command
+* Examples:
+
+#==================================================
+function IGCM_sys_Chmod
+* Purpose: Chmod
+* Examples:
+
+#==================================================
+function IGCM_sys_FileSize
+* Purpose: Filesize
+* Examples:
+
+#==================================================
+function IGCM_sys_TestDir
+* Purpose: Test Directory that must exists
+* Examples:
+
+#==================================================
+function IGCM_sys_TestDirArchive
+* Purpose: Test Directory that must exists on Archive
+* Examples:
+
+#==================================================
+function IGCM_sys_TestFileArchive
+* Purpose: Test file that must NOT EXISTS on Archive
+* Examples:
+
+#==================================================
+function IGCM_sys_Tree
+* Purpose: Tree directories with files on ${ARCHIVE}
+* Examples: IGCM_sys_Tree ${R_IN} ${R_OUT}
+
+#==================================================
+function IGCM_sys_Tar
+* Purpose: master un-tar command
+* Examples:
+
+#==================================================
+function IGCM_sys_UnTar
+* Purpose: master un-tar command
+* Examples:
+
+#==================================================
+function IGCM_sys_Qsub
+* Purpose: Qsub new job
+* Examples:
+
+#==================================================
+function IGCM_sys_QsubPost
+* Purpose: Qsub new job on scalaire
+* Examples:
+
+*************************
+ File transfer functions 
+*************************
+
+#==================================================
+function IGCM_sys_Rsync_out
+* Purpose: treat return val of rsync
+* Examples: IGCM_sys_Rsync_out out_RET_rsync
+  Error values and explanations can depend on your system version.
+#==================================================
+function IGCM_sys_Cp
+* Purpose: generic cp
+* Examples:
+
+#==================================================
+function IGCM_sys_Mv
+* Purpose: generic move
+* Examples:
+
+#==================================================
+function IGCM_sys_Put_Rest
+* Purpose: Put computied restarts on $(ARCHIVE).
+           File and target directory must exist.
+* Examples:
+
+#==================================================
+function IGCM_sys_Put_Out
+* Purpose: Copy a file on $(ARCHIVE) after have chmod it in readonly
+* Examples:
+
+#==================================================
+function IGCM_sys_Get
+* Purpose: Get a file from ${ARCHIVE}
+* Examples: IGCM_sys_Get myfile /destpath/myfile_with_PREFIX
+            IGCM_sys_Get /l Array_contain_myfiles /destpath/
+
+#==================================================
+function IGCM_sys_GetDate_FichWork
+* Purpose: donne la date filesys d'un fichier sur le filesystem WORK
+* Examples:
+
+#==================================================
+function IGCM_sys_GetDate_FichArchive
+* Purpose: donne la date filesys d'un fichier sur le filesystem ARCHIVE 
+* Examples:
+}}}