Clean up the B3 documentation a bit
authorfpizlo@apple.com <fpizlo@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Fri, 29 Jan 2016 23:43:56 +0000 (23:43 +0000)
committerfpizlo@apple.com <fpizlo@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Fri, 29 Jan 2016 23:43:56 +0000 (23:43 +0000)
https://bugs.webkit.org/show_bug.cgi?id=153678

Reviewed by Saam Barati.

* docs/b3/index.html: Fix some links and fix small issues.
* docs/b3/intermediate-representation.html: Clean up some text and fix small issues.

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@195859 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Websites/webkit.org/ChangeLog
Websites/webkit.org/docs/b3/index.html
Websites/webkit.org/docs/b3/intermediate-representation.html

index af59663..1248313 100644 (file)
@@ -1,5 +1,15 @@
 2016-01-29  Filip Pizlo  <fpizlo@apple.com>
 
+        Clean up the B3 documentation a bit
+        https://bugs.webkit.org/show_bug.cgi?id=153678
+
+        Reviewed by Saam Barati.
+
+        * docs/b3/index.html: Fix some links and fix small issues.
+        * docs/b3/intermediate-representation.html: Clean up some text and fix small issues.
+
+2016-01-29  Filip Pizlo  <fpizlo@apple.com>
+
         B3 should have documentation
         https://bugs.webkit.org/show_bug.cgi?id=153658
 
index 2a3ad3b..9c59f81 100644 (file)
@@ -50,7 +50,8 @@ printf("%d\n", function(42)); // prints 44</code></pre>
 
     <h2>B3 IR</h2>
 
-    <p>Clients of B3 usually interact with it using B3 IR.  It's C-like, in the sense that it
+    <p>Clients of B3 usually interact with it using
+      <a href="intermediate-representation.html">B3 IR</a>.  It's C-like, in the sense that it
       models heap references as integers and does not attempt to verify memory accesses.  It
       enforces static single assignment, or SSA for short.  An SSA program will contain only one
       assignment to each variable, which makes it trivial to trace from a use of a variable to
@@ -64,8 +65,8 @@ printf("%d\n", function(42)); // prints 44</code></pre>
       being generated and for callees of the procedure's callsites.  B3 also makes it easy to
       just emit a C call.  There's an opcode for that.</p>
 
-    <p>See <a href="/documentation/b3/intermediate-representation.html">the IR documentation</a>
-      for more info.</p>
+    <p>See <a href="intermediate-representation.html">the IR documentation</a> for more
+      info.</p>
 
     <p>Here's an example of the IR from the example above:</p>
 
@@ -95,7 +96,8 @@ printf("%d\n", function(42)); // prints 44</code></pre>
 
     <h2>Air</h2>
 
-    <p>Air, or Assembly IR, is the way that B3 represents the machine instruction sequence prior
+    <p><a href="assembly-intermediate-representation.html">Air</a>, or Assembly IR, is the way
+      that B3 represents the machine instruction sequence prior
       to code generation.  Air is like assembly, except that in addition to registers it has
       temporaries, and in addition to the native address forms it has abstract ones like "stack"
       (an abstract stack slot) and "callArg" (an abstract location in the outgoing call argument
index a74e97b..7b22817 100644 (file)
 
     <p>Variables, and the instructions that define them, are represented using the Value object.
       The Value object has a return type, an opcode, and zero or more children.  Children are
-      references to other Values.  Values also have a unique 32-bit index that is used as the
-      name.  Those values are used as input to the instruction that computes this value.  For
-      example:</p>
+      references to other Values.  Those values are used as input to the instruction that
+      computes this value.</p>
+    <p>Values also have a unique 32-bit index that is used as the name.</p>
+    
+    <p>Example:</p>
 
     <pre><code>Int32 @3 = Add(@1, @2)</code></pre>