doc/features.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   3     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   4     <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" >
   5 <head>
   6 <title>Features</title>
   7 <link rel="stylesheet" href="style.css" type="text/css" />
   8 </head>
   9 <body>
  10 <div class="body">
  11 <h1>Features</h1>
  12
  13 <p class="first">To aid authors and programs in generating code that
  14 is compatible with a particular Voodoo implementation, implementations
  15 are encouraged to provide means to query their features. This document
  16 specifies a number of features as key-value pairs, where the key is
  17 the feature name, and the value is a string that provides additional
  18 information about the feature (as described in the specification of
  19 the feature).</p>
  20
  21 <p>Implementations may also advertise features not specified in this
  22 document. To prevent conflicts with future versions of Voodoo, these
  23 features should have names starting in <q>x-</q>. Implementations are
  24 encouraged to use this mechanism to advertise support for extensions
  25 to the language specified by this document.</p>
  26
  27 <table summary="Features">
  28 <thead>
  29 <tr><th>Name</th><th>Description</th></tr>
  30 </thead>
  31 <tbody>
  32 <tr>
  33 <td>bits-per-word</td>
  34 <td>The value indicates the number of bits per word for the given
  35 implementation. E.g. 32.</td>
  36 </tr>
  37 <tr>
  38 <td>byte-order</td>
  39 <td>Order of bytes in a word. The following values are defined:
  40 <dl>
  41 <dt>big-endian</dt>
  42 <dd>Bytes are ordered from most significant to least significant</dd>
  43 <dt>little-endian</dt>
  44 <dd>Bytes are ordered from least significant to most significant</dd>
  45 </dl></td>
  46 </tr>
  47 <tr>
  48 <td>bytes-per-word</td>
  49 <td>The number of bytes required to store a word. E.g. 4</td>
  50 </tr>
  51 <tr>
  52 <td>voodoo</td>
  53 <td>Version of the Voodoo language supported by the implementation.
  54 The version described in this document is <q>1.0</q>.</td>
  55 </tbody>
  56 </table>
  57 </div>
  58 </body>
  59 </html>