Selaa lähdekoodia

Merge pull request #10800 from JamesDeFabia/HPCC-18954eclccOptions

HPCC-18954 Update eclcc options in docs

Reviewed-by: Gavin Halliday <ghalliday@hpccsystems.com>
Gavin Halliday 7 vuotta sitten
vanhempi
commit
a4345ec5df
1 muutettua tiedostoa jossa 206 lisäystä ja 33 poistoa
  1. 206 33
      docs/EN_US/HPCCClientTools/CT_Mods/ECLCC.xml

+ 206 - 33
docs/EN_US/HPCCClientTools/CT_Mods/ECLCC.xml

@@ -177,15 +177,6 @@
               </row>
 
               <row>
-                <entry>-checkDirty</entry>
-
-                <entry>Causes eclcc to generate a warning for any attribute
-                that has been modified (according to the output of git
-                status). Use of this function requires that git be installed
-                and available on the path.</entry>
-              </row>
-
-              <row>
                 <entry>-foption[=value]</entry>
 
                 <entry>Set an ecl option. See #OPTION in the <emphasis>ECL
@@ -206,21 +197,15 @@
               </row>
 
               <row>
-                <entry>--nostdinc</entry>
-
-                <entry>Do not include the current directory in -I</entry>
-              </row>
-
-              <row>
                 <entry>-platform=hthor</entry>
 
-                <entry>Generate code for hthor executable (default)</entry>
+                <entry>Generate code for hthor cluster</entry>
               </row>
 
               <row>
                 <entry>-platform=roxie</entry>
 
-                <entry>Generate code for roxie cluster</entry>
+                <entry>Generate code for roxie cluster (default)</entry>
               </row>
 
               <row>
@@ -247,7 +232,7 @@
 
                 <entry><emphasis role="bold">NOTE: </emphasis>If there are
                 spaces in the path you specify, put it in quotes. For example:
-                L"C:\Program Files"</entry>
+                -L"C:\Program Files"</entry>
               </row>
             </tbody>
           </tgroup>
@@ -296,6 +281,12 @@
               </row>
 
               <row>
+                <entry>-qa</entry>
+
+                <entry>Save ECL query archive as part of workunit</entry>
+              </row>
+
+              <row>
                 <entry>-wu</entry>
 
                 <entry>Only generate workunit information as xml file</entry>
@@ -332,7 +323,7 @@
               </row>
 
               <row>
-                <entry>-g</entry>
+                <entry>-g, --debug</entry>
 
                 <entry>Enable debug symbols in generated code</entry>
               </row>
@@ -344,13 +335,6 @@
               </row>
 
               <row>
-                <entry>-D<emphasis>name</emphasis>=<emphasis>value</emphasis></entry>
-
-                <entry>Override the definition of a global attribute
-                'name'</entry>
-              </row>
-
-              <row>
                 <entry>-Wl,xx</entry>
 
                 <entry>Pass option xx to the linker</entry>
@@ -376,6 +360,12 @@
               </row>
 
               <row>
+                <entry>-save-temps</entry>
+
+                <entry>Do not delete intermediate files</entry>
+              </row>
+
+              <row>
                 <entry>-shared</entry>
 
                 <entry>Generate workunit shared object instead of a
@@ -387,7 +377,7 @@
 
       <?dbfo-need height="3in"?>
 
-      <para>Other options:</para>
+      <para>File resolution options:</para>
 
       <para><informaltable colsep="1" frame="all" rowsep="1">
           <?dbfo keep-together="always"?>
@@ -399,18 +389,79 @@
 
             <tbody>
               <row>
+                <entry>-dfs=ip</entry>
+
+                <entry>Use specified ip for DFS filename resolution</entry>
+              </row>
+
+              <row>
+                <entry>-scope=prefix</entry>
+
+                <entry>Use specified scope prefix in DFS filename
+                resolution</entry>
+              </row>
+
+              <row>
+                <entry>-user=id</entry>
+
+                <entry>Use specified username in DFS filename
+                resolution</entry>
+              </row>
+
+              <row>
+                <entry>-password=xxx</entry>
+
+                <entry>Use specified password in DFS filename resolution
+                (blank to prompt)</entry>
+              </row>
+            </tbody>
+          </tgroup>
+        </informaltable></para>
+
+      <?hard-pagebreak ?>
+
+      <para>Other options (list is available using eclcc -help -v):</para>
+
+      <para><informaltable colsep="1" frame="all" rowsep="1">
+          <?dbfo keep-together="always"?>
+
+          <tgroup cols="2">
+            <colspec align="left" colwidth="125.55pt" />
+
+            <colspec />
+
+            <tbody>
+              <row>
+                <entry>-aoption[=value]</entry>
+
+                <entry>Set an application option</entry>
+              </row>
+
+              <row>
                 <entry>--allow=str</entry>
 
                 <entry>Allow use of named feature. (e.g., cpp, pipe,
-                all)<para></para><para><emphasis role="bold">cpp</emphasis>:
-                Allow embedded code within ECL (e.g., c++, JAVA, Javascript,
-                Python, R, etc.)</para><para><emphasis
-                role="bold">pipe</emphasis>: Allow the PIPE command to send
-                data to an external program.</para><para><emphasis
+                all)<para><emphasis role="bold">cpp</emphasis>: Allow embedded
+                code within ECL (e.g., c++, JAVA, Javascript, Python, R,
+                etc.)</para><para><emphasis role="bold">pipe</emphasis>: Allow
+                the PIPE command to send data to an external
+                program.</para><para><emphasis role="bold">userECL</emphasis>:
+                Allow code that is not found via the ecl include
+                paths</para><para><emphasis role="bold">datafile</emphasis>:
+                Allow access to datafiles from ECL. </para><para><emphasis
+                role="bold">extern</emphasis>: Allow access to an external
+                service function</para><para><emphasis
                 role="bold">all</emphasis>: Allow all features</para></entry>
               </row>
 
               <row>
+                <entry>-allowsigned</entry>
+
+                <entry>Only allows access to a feature from signed
+                code</entry>
+              </row>
+
+              <row>
                 <entry>-b</entry>
 
                 <entry>Batch mode. Each source file is processed in turn.
@@ -425,6 +476,29 @@
               </row>
 
               <row>
+                <entry>-checkDirty</entry>
+
+                <entry>Causes eclcc to generate a warning for any attribute
+                that has been modified (according to the output of git
+                status). Use of this function requires that git be installed
+                and available on the path.</entry>
+              </row>
+
+              <row>
+                <entry>--component</entry>
+
+                <entry>Set the name of the component this is executing on
+                behalf of</entry>
+              </row>
+
+              <row>
+                <entry>-D<emphasis>name</emphasis>=<emphasis>value</emphasis></entry>
+
+                <entry>Override the definition of a global attribute
+                'name'</entry>
+              </row>
+
+              <row>
                 <entry>--deny=all</entry>
 
                 <entry>Disallow use of all named features not specifically
@@ -443,7 +517,7 @@
               </row>
 
               <row>
-                <entry>--fastsyntax </entry>
+                <entry>--fastsyntax</entry>
 
                 <entry>Delay expanding functions when parsing. May speed up
                 processing for some queries</entry>
@@ -472,6 +546,23 @@
 
                 <entry>Use legacy import semantics (deprecated)</entry>
               </row>
+            </tbody>
+          </tgroup>
+        </informaltable> <?hard-pagebreak ?> <para>Other options
+      (continued):</para> <informaltable colsep="1" frame="all" rowsep="1">
+          <?dbfo keep-together="always"?>
+
+          <tgroup cols="2">
+            <colspec align="left" colwidth="125.55pt" />
+
+            <colspec />
+
+            <tbody>
+              <row>
+                <entry>--leakcheck</entry>
+
+                <entry>Clean up memory since checking for memory leaks</entry>
+              </row>
 
               <row>
                 <entry>--keywords</entry>
@@ -481,6 +572,19 @@
               </row>
 
               <row>
+                <entry>-legacyimport</entry>
+
+                <entry>Use legacy import semantics (deprecated)</entry>
+              </row>
+
+              <row>
+                <entry>-legacywhen</entry>
+
+                <entry>Use legacy when/side-effects semantics
+                (deprecated)</entry>
+              </row>
+
+              <row>
                 <entry>--logfile <emphasis>&lt;file&gt;</emphasis></entry>
 
                 <entry>Write log to specified file</entry>
@@ -493,6 +597,65 @@
               </row>
 
               <row>
+                <entry>--maxErrors=&lt;n&gt;</entry>
+
+                <entry>Limit the number of errors, aborting on the nth
+                (default = 5)</entry>
+              </row>
+
+              <row>
+                <entry>--metacache=x</entry>
+
+                <entry>Specify directory to store distributed meta
+                information</entry>
+              </row>
+
+              <row>
+                <entry>--nologfile</entry>
+
+                <entry>Do not write any log file</entry>
+              </row>
+
+              <row>
+                <entry>--nogpg</entry>
+
+                <entry>Do not run gpg to check signatures on signed
+                code</entry>
+              </row>
+
+              <row>
+                <entry>--nosourcepath</entry>
+
+                <entry>Compile as if the source came from stdin</entry>
+              </row>
+
+              <row>
+                <entry>--nostdinc</entry>
+
+                <entry>Do not include the current directory in -I</entry>
+              </row>
+
+              <row>
+                <entry>-pch</entry>
+
+                <entry>Generate precompiled header for eclinclude4.hpp</entry>
+              </row>
+
+              <row>
+                <entry>-P &lt;path&gt;</entry>
+
+                <entry>Specify the path of the output files (only with -b
+                option)</entry>
+              </row>
+
+              <row>
+                <entry>-showpaths</entry>
+
+                <entry>Print information about the search paths eclcc is
+                using</entry>
+              </row>
+
+              <row>
                 <entry>-specs <emphasis>&lt;file&gt;</emphasis></entry>
 
                 <entry>Read eclcc configuration from specified file</entry>
@@ -513,6 +676,16 @@
               </row>
 
               <row>
+                <entry>-wxxxx=level</entry>
+
+                <entry>Set the severity for a particular warning code or
+                category. <para>Valid options for level are: all | ignore |
+                log | warning | error | fail</para> <emphasis
+                role="bold">-wall</emphasis> sets default severity for all
+                warnings</entry>
+              </row>
+
+              <row>
                 <entry>--version</entry>
 
                 <entry>Output version information</entry>