update irc channel

[xonotic/gmqcc.git] / doc.html

diff --git a/doc.html b/doc.html
index 453fc42b60d0a51635dd457eb52293de3713bb7b..352171fa4e43a037fd5d6ce97b522dd197f0eae5 100644 (file)
--- a/doc.html
+++ b/doc.html
@@ -21,7 +21,6 @@
                 <p class="header">An Improved Quake C Compiler</p>
                 <ul>
                     <li class="buttons"><a href=index.html>Index</a></li>
-                    <li class="download"><a href="https://github.com/graphitemaster/gmqcc/archive/0.2.2.zip">Download v0.2.2</a></li>
                     <li class="buttons"><a href="https://github.com/graphitemaster/gmqcc/issues">Issues</a></li>
                     <li class="buttons"><a href="doc.html">Documentation</a></li>
                     <li class="buttons"><a href="https://github.com/graphitemaster/gmqcc">View On GitHub</a></li>
@@ -551,13 +550,41 @@ $ cd gmqcc
                             <td>testsuite</td>
                             <td>Builds the testsuite for GMQCC</td>
                         </tr>
+                        <tr>
+                            <td>check, test</td>
+                            <td>Build and executes the testsuite for GMQCC</td>
+                        </tr>
+                        <tr>
+                            <td>pak</td>
+                            <td>Builds the pak utility</td>
+                        </tr>
+                        <tr>
+                            <td>splint</td>
+                            <td>Runs splint (static analysis) on the source</td>
+                        </tr>
+                        <tr>
+                            <td>gource</td>
+                            <td>Runs gource visualization on the source</td>
+                        </tr>
+                        <tr>
+                            <td>gource-record</td>
+                            <td>Runs gource visualization and produces a rendered mp4</td>
+                        </tr>
+                        <tr>
+                            <td>depend</td>
+                            <td>Builds dependinces into the Makefile</td>
+                        </tr>
                         <tr>
                             <td>all</td>
-                            <td>Builds gmqcc, qcvm, and testsuite</td>
+                            <td>Builds gmqcc, qcvm, pak, and testsuite</td>
                         </tr>
                         <tr>
                             <td>install</td>
-                            <td>Installs gmqcc to /usr/local/</td>
+                            <td>Installs gmqcc, qcvm, and documentaion</td>
+                        </tr>
+                        <tr>
+                            <td>uninstall</td>
+                            <td>Uninstalls gmqcc, qcvm, and documentation</td>
                         </tr>
                         <tr>
                             <td>check</td>
@@ -655,18 +682,14 @@ $ cd gmqcc
                     </tr>
                     <tr>
                         <td>F:</td>
-                         <td>Used to set a failure message, this message will be displayed
-                           if the test fails, this tag is optional.</td>
-                    </tr>
-                    <tr>
-                        <td>S:</td>
-                            <td>Used to set a success message, this message will be displayed
-                           if the test succeeds, this tag is optional.
-                           </td>
+                         <td>Used to set test-suite specific flags, currently
+                            the only supported flag is -no-defs which tells the
+                            testsuite to exclude defs.qh.
+                        </td>
                     </tr>
                     <tr>
                        <td>T:</td>
-                            <td>Used to set the procedure for the given task, there are two
+                            <td>Used to set the procedure for the given task, there are four
                            options for this:
                            <ul>
                                <li>-compile&nbsp;
@@ -676,6 +699,8 @@ $ cd gmqcc
                                <li>-fail&nbsp;
                                    This will perform compilation on the requirement it fails, otherwise
                                    the test fails</li>
+                                <li>-pp&nbsp;
+                                    This will perform preprocessing only</li>
                             </ul>
                   
                            This tag must be provided, this tag is NOT optional.
@@ -697,7 +722,7 @@ $ cd gmqcc
                         <td>Used to describe a string of text that should be matched from
                            the output of executing the task.  If this doesn't match the
                            task fails.  This tag must be provided at least once if
-                           T == -execute, otherwise it's erroneous as compilation only
+                           T == -execute or T == -pp, otherwise it's erroneous as compilation only
                            takes place. Multiple M tags are required for multi-line comparision
                         </td>
                     </tr>
@@ -773,6 +798,10 @@ $ cd gmqcc
                             <td>Argument</td>
                             <td>What it does</td>
                         </tr>
+                        <tr>
+                            <td>-h, --help</td>
+                            <td>Print help message</td>
+                        </tr>
                         <tr>
                             <td>-trace</td>
                             <td>Trace the execution call hierarchy.</td>
@@ -789,6 +818,10 @@ $ cd gmqcc
                             <td>-disasm</td>
                             <td>Dissasemble the bytecode into assembly.</td>
                         </tr>
+                        <tr>
+                            <td>-diasm-func</td>
+                            <td>Dissasmble function</td>
+                        </tr>
                         <tr>
                             <td>-printdefs</td>
                             <td>Prints all definitions for the bytecode running.</td>
@@ -797,6 +830,22 @@ $ cd gmqcc
                             <td>-printfields</td>
                             <td>Prints all fields for the bytecode running.</td>
                         </tr>
+                        <tr>
+                            <td>-printfuns</td>
+                            <td>Prints all functions for the bytecode running.</td>
+                        </tr>
+                        <tr>
+                            <td>-v</td>
+                            <td>Be verbose</td>
+                        </tr>
+                        <tr>
+                            <td>-v</td>
+                            <td>Be even more verbose</td>
+                        </tr>
+                        <tr>
+                            <td>-version, --version</td>
+                            <td>Print version information</td>
+                        </tr>
                     </table>
                     
                     <h3>Builtins</h3>
@@ -815,6 +864,11 @@ $ cd gmqcc
                             <tr><td>vlen</td><td>7</td></tr>
                             <tr><td>etos</td><td>8</td></tr>
                             <tr><td>stof</td><td>9</td></tr>
+                            <tr><td>strcat</td><td>10</td></tr>
+                            <tr><td>strcmp</td><td>11</td></tr>
+                            <tr><td>normalize</td><td>12</td></tr>
+                            <tr><td>sqrt</td><td>13</td></tr>
+                            <tr><td>floor</td><td>14</td></tr>
                     </table>
                 </p>
                 <h3>Support or Contact</h3>