Regenerate compiler doc for 2.77.0 release.

grame-cncm · Dec 16, 2024 · 1c80c64 · 1c80c64
1 parent c980dcd
commit 1c80c64
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 16 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -473,5 +473,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.5.3
-Build Date UTC : 2024-12-09 14:05:10.309696+00:00
+Build Date UTC : 2024-12-16 09:31:03.146356+00:00
 -->
diff --git a/docs/manual/options/index.html b/docs/manual/options/index.html
@@ -322,7 +322,7 @@
 
             <li class="nav-item" data-level="1"><a href="#faust-compiler-options" class="nav-link">Faust Compiler Options</a>
               <ul class="nav flex-column">
-            <li class="nav-item" data-level="2"><a href="#faust-compiler-version-2757" class="nav-link">FAUST compiler version 2.75.7</a>
+            <li class="nav-item" data-level="2"><a href="#faust-compiler-version-2770" class="nav-link">FAUST compiler version 2.77.0</a>
               <ul class="nav flex-column">
               </ul>
             </li>
@@ -370,7 +370,7 @@
             <div class="col-md-9 main-container" role="main">
 
 <h1 id="faust-compiler-options">Faust Compiler Options</h1>
-<h2 id="faust-compiler-version-2757">FAUST compiler version 2.75.7</h2>
+<h2 id="faust-compiler-version-2770">FAUST compiler version 2.77.0</h2>
 <pre><code class="language-faust-options">usage : faust [options] file1 [file2 ...].
         where options represent zero or more compiler options 
     and fileN represents a Faust source file (.dsp extension).
@@ -388,14 +388,15 @@ <h2 id="output-options">Output options:</h2>
 <pre><code class="language-faust-options">  -o &lt;file&gt;                               the output file.
   -e        --export-dsp                  export expanded DSP (with all included libraries).
   -uim      --user-interface-macros       add user interface macro definitions to the output code.
+  -rnt      --rust-no-faustdsp-trait      (Rust only) Don't generate FaustDsp trait implmentation.
   -xml                                    generate an XML description file.
   -json                                   generate a JSON description file.
   -O &lt;dir&gt;  --output-dir &lt;dir&gt;            specify the relative directory of the generated output code and of additional generated files (SVG, XML...).
 </code></pre>
 <h2 id="code-generation-options">Code generation options:</h2>
 <hr />
 <pre><code class="language-faust-options">  -lang &lt;lang&gt; --language                 select output language,
-                                          'lang' should be c, cpp (default), cmajor, codebox, csharp, dlang, fir, interp, java, jax, jsfx, julia, llvm, ocpp, rust, vhdl or wast/wasm.
+                                          'lang' should be c, cpp (default), cmajor, codebox, csharp, dlang, fir, interp, java, jax, jsfx, julia, llvm, ocpp, rust, sdf3, vhdl or wast/wasm.
   -single     --single-precision-floats   use single precision floats for internal computations (default).
   -double     --double-precision-floats   use double precision floats for internal computations.
   -quad       --quad-precision-floats     use quad precision floats for internal computations.
@@ -481,6 +482,7 @@ <h2 id="debug-options">Debug options:</h2>
   -sg         --signal-graph              print the internal signal graph in dot format.
   -rg         --retiming-graph            print the internal signal graph after retiming in dot format.
   -norm       --normalized-form           print signals in normalized form and exit.
+  -norm1      --normalized-form1          print signals in normalized form with IDs for shared sub-expressions and exit.
   -me         --math-exceptions           check / for 0 as denominator and remainder, fmod, sqrt, log10, log, acos, asin functions domain.
   -sts        --strict-select             generate strict code for 'selectX' even for stateless branches (both are computed).
   -wall       --warning-all               print all warnings.
@@ -500,6 +502,7 @@ <h2 id="environment-variables">Environment variables:</h2>
 <hr />
 <pre><code class="language-faust-options">  FAUST_DEBUG      = FAUST_LLVM1          print LLVM IR before optimisation.
   FAUST_DEBUG      = FAUST_LLVM2          print LLVM IR after optimisation.
+  FAUST_DEBUG      = FIR_PRINTER          print FIR after generation.
   FAUST_DEBUG      = FAUST_LLVM_NO_FM     deactivate fast-math optimisation in LLVM IR.
   FAUST_DEBUG      = FAUST_DTREE          successive tree pointer allocation to guaranty deterministic compilation.
   FAUST_DTREE_SIZE = &lt;num&gt;                to set the size of each array of successive tree pointers in FAUST_DTREE mode.

diff --git a/docs/qreference/2-install/index.html b/docs/qreference/2-install/index.html
@@ -349,12 +349,12 @@
 
 <h1 id="compiling-and-installing-faust">Compiling and installing <span class="smallcaps">Faust</span></h1>
 <p><a name="install"></a></p>
-<p>The <span class="smallcaps">Faust</span> source distribution <span class="lstinline">faust-2.75.7.tar.gz</span> can be downloaded from GitHub (<a href="https://github.com/grame-cncm/faust/releases">https://github.com/grame-cncm/faust/releases</a>).</p>
+<p>The <span class="smallcaps">Faust</span> source distribution <span class="lstinline">faust-2.77.0.tar.gz</span> can be downloaded from GitHub (<a href="https://github.com/grame-cncm/faust/releases">https://github.com/grame-cncm/faust/releases</a>).</p>
 <h2 id="organization-of-the-distribution">Organization of the distribution</h2>
 <p>The first thing is to decompress the downloaded archive. </p>
-<pre><code>    tar xzf faust-2.75.7.tar.gz
+<pre><code>    tar xzf faust-2.77.0.tar.gz
 </code></pre>
-<p>The resulting <span class="lstinline">faust-2.75.7/</span> folder should contain the following elements:</p>
+<p>The resulting <span class="lstinline">faust-2.77.0/</span> folder should contain the following elements:</p>
 <table>
 <thead>
 <tr>
@@ -407,15 +407,15 @@ <h2 id="organization-of-the-distribution">Organization of the distribution</h2>
 </table>
 <h2 id="compilation">Compilation</h2>
 <p><span class="smallcaps">Faust</span> has no dependencies outside standard libraries. Therefore the compilation should be straightforward. There is no configuration phase, to compile the <span class="smallcaps">Faust</span> compiler simply do :</p>
-<pre><code>    cd faust-2.75.7/
+<pre><code>    cd faust-2.77.0/
     make
 </code></pre>
 <p>If the compilation was successful you can test the compiler before installing it:</p>
-<pre><code>    [cd faust-2.75.7/]
+<pre><code>    [cd faust-2.77.0/]
     ./build/bin/faust -v
 </code></pre>
 <p>It should output:</p>
-<pre><code>FAUST Version 2.75.7
+<pre><code>FAUST Version 2.77.0
 Embedded backends: 
    DSP to C
    DSP to C++
@@ -433,17 +433,17 @@ <h2 id="compilation">Compilation</h2>
 Copyright (C) 2002-2024, GRAME - Centre National de Creation Musicale. All rights reserved. 
 </code></pre>
 <p>Then you can also try to compile one of the examples :</p>
-<pre><code>    [cd faust-2.75.7/]
+<pre><code>    [cd faust-2.77.0/]
     ./build/bin/faust examples/generator/noise.dsp
 </code></pre>
 <p>It should produce some C++ code on the standard output.</p>
 <h2 id="installation">Installation</h2>
 <p>You can install <span class="smallcaps">Faust</span> with:</p>
-<pre><code>    [cd faust-2.75.7/]
+<pre><code>    [cd faust-2.77.0/]
     sudo make install
 </code></pre>
 <p>or</p>
-<pre><code>    [cd faust-2.75.7/]
+<pre><code>    [cd faust-2.77.0/]
     su
     make install
 </code></pre>

diff --git a/docs/search/search_index.json b/docs/search/search_index.json
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz
diff --git a/mkdocs/docs/manual/options.md b/mkdocs/docs/manual/options.md
@@ -1,5 +1,5 @@
 # Faust Compiler Options
-## FAUST compiler version 2.75.7
+## FAUST compiler version 2.77.0
 ~~~faust-options
 usage : faust [options] file1 [file2 ...].
         where options represent zero or more compiler options 
@@ -20,6 +20,7 @@ usage : faust [options] file1 [file2 ...].
   -o <file>                               the output file.
   -e        --export-dsp                  export expanded DSP (with all included libraries).
   -uim      --user-interface-macros       add user interface macro definitions to the output code.
+  -rnt      --rust-no-faustdsp-trait      (Rust only) Don't generate FaustDsp trait implmentation.
   -xml                                    generate an XML description file.
   -json                                   generate a JSON description file.
   -O <dir>  --output-dir <dir>            specify the relative directory of the generated output code and of additional generated files (SVG, XML...).
@@ -28,7 +29,7 @@ usage : faust [options] file1 [file2 ...].
 ---------------------------------------
 ~~~faust-options
   -lang <lang> --language                 select output language,
-                                          'lang' should be c, cpp (default), cmajor, codebox, csharp, dlang, fir, interp, java, jax, jsfx, julia, llvm, ocpp, rust, vhdl or wast/wasm.
+                                          'lang' should be c, cpp (default), cmajor, codebox, csharp, dlang, fir, interp, java, jax, jsfx, julia, llvm, ocpp, rust, sdf3, vhdl or wast/wasm.
   -single     --single-precision-floats   use single precision floats for internal computations (default).
   -double     --double-precision-floats   use double precision floats for internal computations.
   -quad       --quad-precision-floats     use quad precision floats for internal computations.
@@ -117,6 +118,7 @@ usage : faust [options] file1 [file2 ...].
   -sg         --signal-graph              print the internal signal graph in dot format.
   -rg         --retiming-graph            print the internal signal graph after retiming in dot format.
   -norm       --normalized-form           print signals in normalized form and exit.
+  -norm1      --normalized-form1          print signals in normalized form with IDs for shared sub-expressions and exit.
   -me         --math-exceptions           check / for 0 as denominator and remainder, fmod, sqrt, log10, log, acos, asin functions domain.
   -sts        --strict-select             generate strict code for 'selectX' even for stateless branches (both are computed).
   -wall       --warning-all               print all warnings.
@@ -138,6 +140,7 @@ usage : faust [options] file1 [file2 ...].
 ~~~faust-options
   FAUST_DEBUG      = FAUST_LLVM1          print LLVM IR before optimisation.
   FAUST_DEBUG      = FAUST_LLVM2          print LLVM IR after optimisation.
+  FAUST_DEBUG      = FIR_PRINTER          print FIR after generation.
   FAUST_DEBUG      = FAUST_LLVM_NO_FM     deactivate fast-math optimisation in LLVM IR.
   FAUST_DEBUG      = FAUST_DTREE          successive tree pointer allocation to guaranty deterministic compilation.
   FAUST_DTREE_SIZE = <num>                to set the size of each array of successive tree pointers in FAUST_DTREE mode.