Merge pull request #18778 from JamesDeFabia/HPCC-32074Wrap

HPCC-32074 Document 'wrap' parameter for Std.File.Copy and fCopy Reviewed-By: Dan S. Camper <[email protected]> Merged-by: Gavin Halliday <[email protected]>
hpcc-systems · Jun 19, 2024 · a6abde3 · a6abde3
2 parents f6681e7 + 0176a72
commit a6abde3
Showing 1 changed file with 17 additions and 6 deletions.
diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/Copy.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/Copy.xml
@@ -28,9 +28,9 @@
   [</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>
+  role="bold">] [</emphasis> <emphasis>,ensure</emphasis> <emphasis
+  role="bold">] [</emphasis> <emphasis>,wrap</emphasis> <emphasis
+  role="bold">] );</emphasis></para>
 
   <para><emphasis>dfuwuid</emphasis> <emphasis role="bold"> :=
   STD.File.fCopy<indexterm>
@@ -57,9 +57,9 @@
   [</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>
+  role="bold">] [</emphasis> <emphasis>,ensure</emphasis><emphasis
+  role="bold">] [</emphasis> <emphasis>,wrap</emphasis> <emphasis
+  role="bold">] );</emphasis></para>
 
   <informaltable colsep="1" frame="all" rowsep="1">
     <tgroup cols="2">
@@ -215,6 +215,17 @@
           if they already exist. Default is FALSE.</entry>
         </row>
 
+        <row>
+          <entry><emphasis>wrap</emphasis></entry>
+
+          <entry>Optional. A boolean TRUE or FALSE flag indicating whether to
+          automatically wrap the file parts when copying to smaller sized
+          clusters. For example, copying from a 6-node cluster to a 3-node
+          cluster, two file parts will end up on each node; the difference is
+          whether node 1 gets parts 1 and 2 or parts 1 and 4. If omitted, the
+          default is FALSE.</entry>
+        </row>
+
         <row>
           <entry><emphasis>dfuwuid</emphasis></entry>