svn commit: r1800448 - in /uima/uima-ducc/trunk: uima-ducc-common/src/main/java/org/apache/uima/ducc/common/IDuccUser.java uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-submit.tex

[bu...@apache.org]

Author: burn
Date: Fri Jun 30 18:32:12 2017
New Revision: 1800448

URL: http://svn.apache.org/viewvc?rev=1800448&view=rev
Log:
UIMA-5428 Document DUCC_KEEP_TEMPORARY_DESCRIPTORS

Modified:
    uima/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/IDuccUser.java
    uima/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-submit.tex

Modified: uima/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/IDuccUser.java
URL: http://svn.apache.org/viewvc/uima/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/IDuccUser.java?rev=1800448&r1=1800447&r2=1800448&view=diff
==============================================================================
--- uima/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/IDuccUser.java (original)
+++ uima/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/IDuccUser.java Fri Jun 30 18:32:12 2017
@@ -23,6 +23,7 @@ package org.apache.uima.ducc.common;
 public interface IDuccUser {
 
 	public enum EnvironmentVariable {
+	  // These are set internally and may be used by applications
 		DUCC_HOME("DUCC_HOME"),
 		DUCC_ID_JOB("DUCC_JOBID"),
 		DUCC_ID_PROCESS("DUCC_PROCESSID"),
@@ -30,12 +31,14 @@ public interface IDuccUser {
 		DUCC_ID_SERVICE("DUCC_SERVICE_INSTANCE"),
 		DUCC_LOG_PREFIX("DUCC_PROCESS_LOG_PREFIX"),
 		DUCC_UPDATE_PORT("DUCC_STATE_UPDATE_PORT"),
-		//
 		DUCC_IP("DUCC_IP"),
 		DUCC_NODENAME("DUCC_NODENAME"),
-		//
+		
+		// These may be set externally
 		DUCC_USER_CP_PREPEND("DUCC_USER_CP_PREPEND"),
-		//
+		DUCC_KEEP_TEMPORARY_DESCRIPTORS("DUCC_KEEP_TEMPORARY_DESCRIPTORS"),  /* The literal value is used in DeployableGenerator */
+		
+		// This is set when running with simulated users
 		USER("USER"),
 		;
 

Modified: uima/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-submit.tex
URL: http://svn.apache.org/viewvc/uima/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-submit.tex?rev=1800448&r1=1800447&r2=1800448&view=diff
==============================================================================
--- uima/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-submit.tex (original)
+++ uima/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-submit.tex Fri Jun 30 18:32:12 2017
@@ -143,6 +143,11 @@
     specified log directory and will place an individual json.gz file for each 
     work item successfully processed comprising its performance breakdown.
     
+    \item[DUCC\_KEEP\_TEMPORARY\_DESCRIPTORS {[true]}  ]
+    If specified, DUCC will not delete any temporary descriptors it creates
+    (these are usually deleted when the process ends.)  DUCC may make a local file copy if the
+    descriptor is in a jar, or if the filesystem is not shared.
+    
   \end{enumerate}