Some changes to the online documentation

This commit is contained in:
Dale Weiler 2013-04-21 10:47:06 +00:00
parent a17492376e
commit 56c0fa48c8

View file

@ -655,14 +655,10 @@ $ cd gmqcc
</tr> </tr>
<tr> <tr>
<td>F:</td> <td>F:</td>
<td>Used to set a failure message, this message will be displayed <td>Used to set test-suite specific flags, currently
if the test fails, this tag is optional.</td> the only supported flag is -no-defs which tells the
</tr> testsuite to exclude defs.qh.
<tr> </td>
<td>S:</td>
<td>Used to set a success message, this message will be displayed
if the test succeeds, this tag is optional.
</td>
</tr> </tr>
<tr> <tr>
<td>T:</td> <td>T:</td>
@ -676,6 +672,8 @@ $ cd gmqcc
<li>-fail&nbsp; <li>-fail&nbsp;
This will perform compilation on the requirement it fails, otherwise This will perform compilation on the requirement it fails, otherwise
the test fails</li> the test fails</li>
<li>-pp&nbsp;
This will perform preprocessing only</li>
</ul> </ul>
This tag must be provided, this tag is NOT optional. This tag must be provided, this tag is NOT optional.
@ -697,7 +695,7 @@ $ cd gmqcc
<td>Used to describe a string of text that should be matched from <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 the output of executing the task. If this doesn't match the
task fails. This tag must be provided at least once if 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 takes place. Multiple M tags are required for multi-line comparision
</td> </td>
</tr> </tr>
@ -773,6 +771,10 @@ $ cd gmqcc
<td>Argument</td> <td>Argument</td>
<td>What it does</td> <td>What it does</td>
</tr> </tr>
<tr>
<td>-h, --help</td>
<td>Print help message</td>
</tr>
<tr> <tr>
<td>-trace</td> <td>-trace</td>
<td>Trace the execution call hierarchy.</td> <td>Trace the execution call hierarchy.</td>
@ -789,6 +791,10 @@ $ cd gmqcc
<td>-disasm</td> <td>-disasm</td>
<td>Dissasemble the bytecode into assembly.</td> <td>Dissasemble the bytecode into assembly.</td>
</tr> </tr>
<tr>
<td>-diasm-func</td>
<td>Dissasmble function</td>
</tr>
<tr> <tr>
<td>-printdefs</td> <td>-printdefs</td>
<td>Prints all definitions for the bytecode running.</td> <td>Prints all definitions for the bytecode running.</td>
@ -797,6 +803,22 @@ $ cd gmqcc
<td>-printfields</td> <td>-printfields</td>
<td>Prints all fields for the bytecode running.</td> <td>Prints all fields for the bytecode running.</td>
</tr> </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> </table>
<h3>Builtins</h3> <h3>Builtins</h3>
@ -815,6 +837,11 @@ $ cd gmqcc
<tr><td>vlen</td><td>7</td></tr> <tr><td>vlen</td><td>7</td></tr>
<tr><td>etos</td><td>8</td></tr> <tr><td>etos</td><td>8</td></tr>
<tr><td>stof</td><td>9</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> </table>
</p> </p>
<h3>Support or Contact</h3> <h3>Support or Contact</h3>