From 1cfaf2e723968443611b06895212d4328b4881de Mon Sep 17 00:00:00 2001
From: Thomas Lively <7121787+tlively@users.noreply.github.com>
Date: Thu, 9 Apr 2020 11:57:19 -0700
Subject: [NFC] Update readme to discuss tuples rather than push/pop (#2722)

General multivalue and stacky code is now represented using
tuples. Push should never be used and should be removed, and pop
should only be used for exception catch blocks.
---
 README.md | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index ad500a69c..47886f764 100644
--- a/README.md
+++ b/README.md
@@ -69,9 +69,11 @@ There are a few differences between Binaryen IR and the WebAssembly language:
      it can read a wasm text file if it contains only s-expressions.
    * Binaryen uses Stack IR to optimize "stacky" code (that can't be
      represented in structured form).
-   * In rare cases stacky code must be represented in Binaryen IR as well, like
-     popping a value in an exception catch. To support that Binaryen IR has
-     `push` and `pop` instructions.
+   * When stacky code must be represented in Binaryen IR, such as with
+     multivalue instructions and blocks, it is represented with tuple types that
+     do not exist in the WebAssembly language. In addition to multivalue
+     instructions, locals and globals can also have tuple types in Binaryen IR
+     but not in WebAssembly.
  * Types and unreachable code
    * WebAssembly limits block/if/loop types to none and the concrete value types
      (i32, i64, f32, f64). Binaryen IR has an unreachable type, and it allows
-- 
cgit v1.2.3