Merge pull request #17242 from JamesDeFabia/HPCC-28683espserverIPport

HPCC-28683 Std.File functions espserverIPport parameter should be omitted Reviewed-By: Richard Taylor <[email protected]> Merged-by: Gavin Halliday <[email protected]>
hpcc-systems · Apr 17, 2023 · 3aa3c72 · 3aa3c72
2 parents 3169766 + 5b47c92
commit 3aa3c72
Show file tree

Hide file tree

Showing 11 changed files with 67 additions and 56 deletions.
diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/AbortDfuWorkunit.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/AbortDfuWorkunit.xml
@@ -33,11 +33,12 @@
         <row>
           <entry><emphasis>espserverIPport</emphasis></entry>
 
-          <entry>Optional. A null-terminated string containing the protocol,
-          IP, port, and directory, or the DNS equivalent, of the ESP server
-          program. This is usually the same IP and port as ECL Watch, with
-          "/FileSpray" appended. If omitted, the default is the value
-          contained in the lib_system.ws_fs_server attribute.</entry>
+          <entry>Optional. This should almost always be omitted, which then
+          defaults to the value contained in the lib_system.ws_fs_server
+          attribute. When not omitted, it should be a null-terminated string
+          containing the protocol, IP, port, and directory, or the DNS
+          equivalent, of the ESP server program. This is usually the same IP
+          and port as ECL Watch, with "/FileSpray" appended. </entry>
         </row>
       </tbody>
     </tgroup>

diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/Copy.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/Copy.xml
@@ -105,11 +105,12 @@
         <row>
           <entry><emphasis>espServerIPPort</emphasis></entry>
 
-          <entry>Optional. A null-terminated string containing the protocol,
-          IP, port, and directory, or the DNS equivalent, of the ESP server
-          program. This is usually the same IP and port as ECL Watch, with
-          "/FileSpray" appended. If omitted, the default is the value
-          contained in the lib_system.ws_fs_server attribute.</entry>
+          <entry>Optional. This should almost always be omitted, which then
+          defaults to the value contained in the lib_system.ws_fs_server
+          attribute. When not omitted, it should be a null-terminated string
+          containing the protocol, IP, port, and directory, or the DNS
+          equivalent, of the ESP server program. This is usually the same IP
+          and port as ECL Watch, with "/FileSpray" appended.</entry>
         </row>
 
         <row>

diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/DeSpray.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/DeSpray.xml
@@ -58,7 +58,7 @@
 
           <entry>A null-terminated string containing the destination IP
           address of the file. Deprecated, you should use destinationPlane
-          instead. </entry>
+          instead.</entry>
         </row>
 
         <row>
@@ -80,11 +80,12 @@
         <row>
           <entry><emphasis>espserverIPport</emphasis></entry>
 
-          <entry>Optional. A null-terminated string containing the protocol,
-          IP, port, and directory, or the DNS equivalent, of the ESP server
-          program. This is usually the same IP and port as ECL Watch, with
-          "/FileSpray" appended. If omitted, the default is the value
-          contained in the lib_system.ws_fs_server attribute.</entry>
+          <entry>Optional. This should almost always be omitted, which then
+          defaults to the value contained in the lib_system.ws_fs_server
+          attribute. When not omitted, it should be a null-terminated string
+          containing the protocol, IP, port, and directory, or the DNS
+          equivalent, of the ESP server program. This is usually the same IP
+          and port as ECL Watch, with "/FileSpray" appended.</entry>
         </row>
 
         <row>

diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/MonitorFile.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/MonitorFile.xml
@@ -86,11 +86,12 @@
         <row>
           <entry><emphasis>espserverIPport</emphasis></entry>
 
-          <entry>Optional. A null-terminated string containing the protocol,
-          IP, port, and directory, or the DNS equivalent, of the ESP server
-          program. This is usually the same IP and port as ECL Watch, with
-          "/FileSpray" appended. If omitted, the default is the value
-          contained in the lib_system.ws_fs_server attribute.</entry>
+          <entry>Optional. This should almost always be omitted, which then
+          defaults to the value contained in the lib_system.ws_fs_server
+          attribute. When not omitted, it should be a null-terminated string
+          containing the protocol, IP, port, and directory, or the DNS
+          equivalent, of the ESP server program. This is usually the same IP
+          and port as ECL Watch, with "/FileSpray" appended.</entry>
         </row>
 
         <row>

diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/MonitorLogicalFileName.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/MonitorLogicalFileName.xml
@@ -64,11 +64,12 @@
         <row>
           <entry><emphasis>espserverIPport</emphasis></entry>
 
-          <entry>Optional. A null-terminated string containing the protocol,
-          IP, port, and directory, or the DNS equivalent, of the ESP server
-          program. This is usually the same IP and port as ECL Watch, with
-          "/FileSpray" appended. If omitted, the default is the value
-          contained in the lib_system.ws_fs_server attribute.</entry>
+          <entry>Optional. This should almost always be omitted, which then
+          defaults to the value contained in the lib_system.ws_fs_server
+          attribute. When not omitted, it should be a null-terminated string
+          containing the protocol, IP, port, and directory, or the DNS
+          equivalent, of the ESP server program. This is usually the same IP
+          and port as ECL Watch, with "/FileSpray" appended.</entry>
         </row>
 
         <row>

diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/Replicate.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/Replicate.xml
@@ -47,11 +47,12 @@
         <row>
           <entry><emphasis>espserverIPport</emphasis></entry>
 
-          <entry>Optional. A null-terminated string containing the protocol,
-          IP, port, and directory, or the DNS equivalent, of the ESP server
-          program. This is usually the same IP and port as ECL Watch, with
-          "/FileSpray" appended. If omitted, the default is the value
-          contained in the lib_system.ws_fs_server attribute.</entry>
+          <entry>Optional. This should almost always be omitted, which then
+          defaults to the value contained in the lib_system.ws_fs_server
+          attribute. When not omitted, it should be a null-terminated string
+          containing the protocol, IP, port, and directory, or the DNS
+          equivalent, of the ESP server program. This is usually the same IP
+          and port as ECL Watch, with "/FileSpray" appended.</entry>
         </row>
 
         <row>

diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayFixed.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayFixed.xml
@@ -114,11 +114,12 @@
         <row>
           <entry><emphasis>espserverIPport</emphasis></entry>
 
-          <entry>A null-terminated string containing the protocol, IP, port,
-          and directory, or the DNS equivalent, of the ESP server program.
-          This is usually the same IP and port as ECL Watch, with "/FileSpray"
-          appended. If omitted, the default is the value contained in the
-          lib_system.ws_fs_server attribute.</entry>
+          <entry>Optional. This should almost always be omitted, which then
+          defaults to the value contained in the lib_system.ws_fs_server
+          attribute. When not omitted, it should be a null-terminated string
+          containing the protocol, IP, port, and directory, or the DNS
+          equivalent, of the ESP server program. This is usually the same IP
+          and port as ECL Watch, with "/FileSpray" appended.</entry>
         </row>
 
         <row>

diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayJson.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayJson.xml
@@ -141,11 +141,12 @@
         <row>
           <entry><emphasis>espserverIPport</emphasis></entry>
 
-          <entry>Optional. A null-terminated string containing the protocol,
-          IP, port, and directory, or the DNS equivalent, of the ESP server
-          program. This is usually the same IP and port as ECL Watch, with
-          "/FileSpray" appended. If omitted, the default is the value
-          contained in the lib_system.ws_fs_server attribute.</entry>
+          <entry>Optional. This should almost always be omitted, which then
+          defaults to the value contained in the lib_system.ws_fs_server
+          attribute. When not omitted, it should be a null-terminated string
+          containing the protocol, IP, port, and directory, or the DNS
+          equivalent, of the ESP server program. This is usually the same IP
+          and port as ECL Watch, with "/FileSpray" appended.</entry>
         </row>
 
         <row>

diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayVariable.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayVariable.xml
@@ -166,11 +166,12 @@
         <row>
           <entry><emphasis>espServerIpPort</emphasis></entry>
 
-          <entry>Optional. A null-terminated string containing the protocol,
-          IP, port, and directory, or the DNS equivalent, of the ESP server
-          program. This is usually the same IP and port as ECL Watch, with
-          "/FileSpray" appended. If omitted, the default is the value in the
-          lib_system.ws_fs_server attribute.</entry>
+          <entry>Optional. This should almost always be omitted, which then
+          defaults to the value contained in the lib_system.ws_fs_server
+          attribute. When not omitted, it should be a null-terminated string
+          containing the protocol, IP, port, and directory, or the DNS
+          equivalent, of the ESP server program. This is usually the same IP
+          and port as ECL Watch, with "/FileSpray" appended.</entry>
         </row>
 
         <row>

diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayXML.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayXML.xml
@@ -140,11 +140,12 @@
         <row>
           <entry><emphasis>espserverIPport</emphasis></entry>
 
-          <entry>Optional. A null-terminated string containing the protocol,
-          IP, port, and directory, or the DNS equivalent, of the ESP server
-          program. This is usually the same IP and port as ECL Watch, with
-          "/FileSpray" appended. If omitted, the default is the value
-          contained in the lib_system.ws_fs_server attribute.</entry>
+          <entry>Optional. This should almost always be omitted, which then
+          defaults to the value contained in the lib_system.ws_fs_server
+          attribute. When not omitted, it should be a null-terminated string
+          containing the protocol, IP, port, and directory, or the DNS
+          equivalent, of the ESP server program. This is usually the same IP
+          and port as ECL Watch, with "/FileSpray" appended.</entry>
         </row>
 
         <row>

diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/WaitDfuWorkunit.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/WaitDfuWorkunit.xml
@@ -43,11 +43,12 @@
         <row>
           <entry><emphasis>espserverIPport</emphasis></entry>
 
-          <entry>Optional. A null-terminated string containing the protocol,
-          IP, port, and directory, or the DNS equivalent, of the ESP server
-          program. This is usually the same IP and port as ECL Watch, with
-          "/FileSpray" appended. If omitted, the default is the value
-          contained in the lib_system.ws_fs_server attribute.</entry>
+          <entry>Optional. This should almost always be omitted, which then
+          defaults to the value contained in the lib_system.ws_fs_server
+          attribute. When not omitted, it should be a null-terminated string
+          containing the protocol, IP, port, and directory, or the DNS
+          equivalent, of the ESP server program. This is usually the same IP
+          and port as ECL Watch, with "/FileSpray" appended.</entry>
         </row>
 
         <row>