From 9666f3dd7ee41f8d41e4efb8f70375847e3a41cc Mon Sep 17 00:00:00 2001
From: drotos <drotos@a7169a2c-3604-0410-bc95-c702d8d87f7a>
Date: Thu, 19 Oct 2006 10:32:49 +0000
Subject: [PATCH] documentation of configuration options

git-svn-id: svn+ssh://cvs.lpds.sztaki.hu/var/lib/svn/szdg/dcapi/trunk@944 a7169a2c-3604-0410-bc95-c702d8d87f7a
---
 dcapi/doc/condor.xml | 117 ++++++++++++++++++++++++++++++++++++-------
 1 file changed, 98 insertions(+), 19 deletions(-)

diff --git a/dcapi/doc/condor.xml b/dcapi/doc/condor.xml
index 522cc80422..b6ec79645e 100644
--- a/dcapi/doc/condor.xml
+++ b/dcapi/doc/condor.xml
@@ -15,7 +15,7 @@
 
   <para>
   All files that generated by the application including the master and
-  the worker programs and the DC-API library itself are places under a
+  the worker programs and the DC-API library itself are placed under a
   directory called <emphasis>working directory</emphasis>.
   </para>
 
@@ -62,11 +62,46 @@
 
       <variablelist>
 
+        <varlistentry>
+	  <term>InstanceUUID</term>
+	  <listitem>
+	    <para>
+
+	    REQUIRED. Identification of running instance of the
+	  application. For CONDOR backend it can be any string not
+	  just an UUID.
+
+	    </para>
+	  </listitem>
+	</varlistentry>
+
+        <varlistentry>
+	  <term>WorkingDirectory</term>
+	  <listitem>
+	    <para>
+	    
+	    REQUIRED. Name of working directory of the
+	    application. All files that are generated by the
+	    application or the DC-API library are placed under this
+	    directory. Different applications can use the same working
+	    directory because every instance has its own subdirectory
+	    there.
+
+	    </para>
+	  </listitem>
+	</varlistentry>
+
         <varlistentry>
 	  <term>ClientMessageBox</term>
 	  <listitem>
 	    <para>
-	    default=_dcapi_client_messages
+
+	    Name of the directory in workunit's working directory
+	    where messages are placed which are sent by the client to
+	    the master by <function><link
+	    linked="DC-sendMessage">DC_sendMessage()</link></function>. Default
+	    value is <filename>_dcapi_client_messages</filename>.
+
 	    </para>
 	  </listitem>
 	</varlistentry>
@@ -75,7 +110,13 @@
 	  <term>MasterMessageBox</term>
 	  <listitem>
 	    <para>
-	    default=_dcapi_master_messages
+
+	    Name of the directory in workunit's working directory
+	    where <function><link
+	    linked="DC-sendWUMessage">DC_sendWUMessage()</link></function>
+	    places messaged sent by the master to the client. Default
+	    value is <filename>_dcapi_master_messages</filename>.
+
 	    </para>
 	  </listitem>
 	</varlistentry>
@@ -84,7 +125,13 @@
 	  <term>SubresultBox</term>
 	  <listitem>
 	    <para>
-	    default=_dcapi_client_subresults
+
+	    Name of the directory in workunit's working directory
+	    where <function><link
+	    linked="DC-sendResult">DC_sendResult()</link></function>
+	    places subresults generated by the client. Default
+	    value is <filename>_dcapi_client_subresults</filename>.
+
 	    </para>
 	  </listitem>
 	</varlistentry>
@@ -93,16 +140,13 @@
 	  <term>SystemMessageBox</term>
 	  <listitem>
 	    <para>
-	    default=_dcapi_system_messages
-	    </para>
-	  </listitem>
-	</varlistentry>
 
-	<varlistentry>
-	  <term>Architectures</term>
-	  <listitem>
-	    <para>
-	    default=Client_%s_%s/* client_name, architecture */
+	    Name of the directory in workunit's working directory
+	    where the master and client program place management
+	    messages for example when the master asks the client to
+	    suspend and it sends back an acknowlegde. Default value is
+	    <filename>_dcapi_system_messages</filename>
+
 	    </para>
 	  </listitem>
 	</varlistentry>
@@ -111,7 +155,12 @@
 	  <term>SubmitFile</term>
 	  <listitem>
 	    <para>
-	    default=_dcapi_condor_submit.txt
+
+	    Name of the file in workunit's working directory which is
+	    generated by the master and used as submit information for
+	    Condor when a workunit is prepared to start. Default value
+	    is <filename>_dcapi_condor_submit.txt</filename>.
+
 	    </para>
 	  </listitem>
 	</varlistentry>
@@ -120,7 +169,12 @@
 	  <term>Executable</term>
 	  <listitem>
 	    <para>
-	    default=NULL
+
+	    Name of the executable file of the client (workunit). By
+	    default it is the <parameter>clientName</parameter>
+	    parameter which was passed to <function><link
+	    linked="DC-createWU">DC_createWU()</link></function>.
+
 	    </para>
 	  </listitem>
 	</varlistentry>
@@ -129,7 +183,12 @@
 	  <term>LeaveFiles</term>
 	  <listitem>
 	    <para>
-	    default=0
+	    
+	    Specifies if files, directories generated in workunit's
+	    working directory should be deleted or not after workunit
+	    ends. Zero value means delete and non-zero value means not
+	    to delete. Default value is 0.
+
 	    </para>
 	  </listitem>
 	</varlistentry>
@@ -138,7 +197,12 @@
 	  <term>CondorLog</term>
 	  <listitem>
 	    <para>
-	    default=_dcapi_internal_log.txt
+
+	    Name of the file in workunit's working directory where
+	    Condor writes records about events happen to the Condor
+	    job. Default value is
+	    <filename>_dcapi_internal_log.txt</filename>.
+
 	    </para>
 	  </listitem>
 	</varlistentry>
@@ -147,7 +211,16 @@
 	  <term>CheckpointFile</term>
 	  <listitem>
 	    <para>
-	    default=_dcapi_checkpoint
+
+	    Name of file in workunit's working directory where
+	    checkpoint information is written by the
+	    client. <function><link
+	    linked="DC-resolveFileName">DC_resolveFileName()</link></function>
+	    will resolve <link
+	    linked="DC_CHECKPOINT_FILE:CAPS">DC_CHECKPOINT_FILE</link>
+	    to this name. Default value is
+	    <filename>_dcapi_checkpoint</filename>.
+
 	    </para>
 	  </listitem>
 	</varlistentry>
@@ -156,7 +229,13 @@
 	  <term>SavedOutputs</term>
 	  <listitem>
 	    <para>
-	    default=_dcapi_saved_output
+
+	    Name of directory in workunit's working directory where
+	    workunit's standard output is saved when it is
+	    suspended. Deafult values is
+	    <filename>_dcapi_saved_output</filename>. There is no
+	    facility in the DC-API yet to merge saved output together.
+
 	    </para>
 	  </listitem>
 	</varlistentry>