[JSC] Update the documentation of B3's Return opcode
authorcommit-queue@webkit.org <commit-queue@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Wed, 17 Aug 2016 02:01:03 +0000 (02:01 +0000)
committercommit-queue@webkit.org <commit-queue@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Wed, 17 Aug 2016 02:01:03 +0000 (02:01 +0000)
https://bugs.webkit.org/show_bug.cgi?id=160912

Patch by Benjamin Poulain <bpoulain@apple.com> on 2016-08-16
Reviewed by Filip Pizlo.

* docs/b3/intermediate-representation.html:

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

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

index 2713051..7e86132 100644 (file)
@@ -1,3 +1,12 @@
+2016-08-16  Benjamin Poulain  <bpoulain@apple.com>
+
+        [JSC] Update the documentation of B3's Return opcode
+        https://bugs.webkit.org/show_bug.cgi?id=160912
+
+        Reviewed by Filip Pizlo.
+
+        * docs/b3/intermediate-representation.html:
+
 2016-08-04  Daniel Bates  <dabates@apple.com>
 
         Add some files for a Content Security Policy blog post
index fa8385c..ff9de5d 100644 (file)
@@ -595,9 +595,16 @@ root->appendSuccessor(thirdEntrypoint);</code></pre>
           leads to only a small amount of cloned code in practice.</p>
       </dd>
 
-      <dt>Void Return(T)</dt>
-      <dd>Works for any type except Void.  Returns the given value and terminates the procedure.
-        Must appear at the end of the basic block. The block must have zero successors.</dd>
+      <dt>Void Return(T <i>(optional)</i>)</dt>
+      <dd>
+          <p>
+            Returns the control flow to the caller and terminates the procedure.
+            Must appear at the end of the basic block. The block must have zero successors.
+          </p>
+          <p>
+            If the node has a child, its value is returned. The type of the child can be any type except Void.
+          </p>
+      </dd>
 
       <dt>Void Oops()</dt>
       <dd>Indicates unreachable code.  This may be implemented as either a trap or as a bare