Changeset 32876 for trunk/ippdor/src/ipp/constants/Chip.py

Timestamp:

Dec 7, 2011, 10:20:55 AM (15 years ago)

Author:

Serge CHASTEL

Message:

Code documentation

File:

• trunk/ippdor/src/ipp/constants/Chip.py (modified) (3 diffs)

trunk/ippdor/src/ipp/constants/Chip.py

@@ -10 +10 @@
 class Chip:
     """
-    This class is not intended to be used as a class instance.
+    This class is not intended to be instantiated.
     All its members are static.
     """
@@ -18 +18 @@
     REQUIREMENTS = 'LoadAvg < 0.3'
     email_subject = ''
+
+    # This is the e-mail body which is sent when revert as
+    # failed. Some values need to be replaced, namely:
+    # - @COUNT_FAILED_CHIPS@: the number of chips which have failed;
+    # - @LABEL@: the label;
+    # - @EXPOSURE_NAME@: the exposure name;
+    # - @LIST_PROCESSING_LOGS@: the list of log files that should be
+    #   checked by the operator;
+    # - @CHIPTOOL_UPDATEPROCESSEDIMFILE@: the list of commands that
+    #   could be run to ignore some flaky OTAs
+    # - @CHIPTOOL_REVERTPROCESSEDIMFILE@: the command that shoudl be
+    #   run to revert the exposure.
+    # It is also expected to valuate this expression with one argument:
+    # - #1: The path to Globals.LOCAL_TMP_DIR
     email_body_failed_revert = """Hi,
 
@@ -38 +52 @@
 
 Once you have FIXED ALL PROBLEMS FOR ALL EXPOSURES, on the host where the Condor task was submitted, submit the DAG (the host name is shown in the following line) again:
-condor_submit_dag -maxidle 1000 -maxjobs 500 %s/%s/ch2st.dag
+condor_submit_dag -maxidle 1000 -maxjobs 500 %s/@LABEL@/ch2st.dag
 
 Thanks,