HPCC-30874 Document ensure option on dfuplus & std.file.copy

Signed-off-by: Jim DeFabia <jamesdefabia@lexisnexis.com>
hpcc-systems · Dec 8, 2023 · 53105f8 · 53105f8
1 parent 2c6648f
commit 53105f8
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/Copy.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/Copy.xml
@@ -28,6 +28,8 @@
   [</emphasis> <emphasis>,preserveCompression</emphasis> <emphasis
   role="bold">] [</emphasis> <emphasis>,noSplit</emphasis> <emphasis
   role="bold">] [</emphasis> <emphasis>,expireDays</emphasis> <emphasis
+  role="bold">] [</emphasis>
+  <emphasis>,ensure</emphasis> <emphasis
   role="bold">]);</emphasis></para>
 
   <para><emphasis>dfuwuid</emphasis> <emphasis role="bold"> :=
@@ -55,7 +57,9 @@
   [</emphasis> <emphasis>,preserveCompression</emphasis> <emphasis
   role="bold">] [</emphasis> <emphasis>,noSplit</emphasis> <emphasis
   role="bold">] [</emphasis> <emphasis>,expireDays</emphasis> <emphasis
-  role="bold">]);</emphasis></para>
+  role="bold">] [</emphasis>
+  <emphasis>,ensure</emphasis><emphasis role="bold">]);
+  </emphasis></para>
 
   <informaltable colsep="1" frame="all" rowsep="1">
     <tgroup cols="2">
@@ -204,6 +208,13 @@
           role="bold">expiryDefault</emphasis> setting.</entry>
         </row>
 
+        <row>
+          <entry><emphasis>ensure</emphasis></entry>
+
+          <entry>Optional. Copies logical file, but does not copy file parts
+          if they already exist. Default is FALSE.</entry>
+        </row>
+
         <row>
           <entry><emphasis>dfuwuid</emphasis></entry>
 

diff --git a/docs/EN_US/HPCCClientTools/CT_Mods/CT_Comm_Line_DFU.xml b/docs/EN_US/HPCCClientTools/CT_Mods/CT_Comm_Line_DFU.xml
@@ -645,7 +645,7 @@ dfuplus action=spray srcplane=lzstorageplane
                   If omitted, the information must be supplied by the
                   <emphasis>dstxml</emphasis> or <emphasis>dstplane</emphasis>
                   parameter. Deprecated, you should use
-                  <emphasis>dstplane</emphasis> instead. </entry>
+                  <emphasis>dstplane</emphasis> instead.</entry>
                 </row>
 
                 <row>
@@ -868,6 +868,13 @@ dfuplus action=despray srcname=mytest::test:spraytest
                   to preserve the compression of the source file. If omitted,
                   the default is 1.</entry>
                 </row>
+
+                <row>
+                  <entry><emphasis>ensure</emphasis></entry>
+
+                  <entry>Optional. Copies logical file, but does not copy file
+                  parts if they already exist. Default is FALSE.</entry>
+                </row>
               </tbody>
             </tgroup>
           </informaltable>