From a0edcab26d30d0822386931e2d09003994da2bb8 Mon Sep 17 00:00:00 2001
From: Eryn Wells <eryn@erynwells.me>
Date: Sun, 13 Jul 2014 09:22:53 -0700
Subject: [PATCH] Comment about swapping env and build_env in do_sconscript()

---
 SConstruct | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/SConstruct b/SConstruct
index 203cfb1..140ab6a 100644
--- a/SConstruct
+++ b/SConstruct
@@ -148,6 +148,9 @@ def create_env(name, appends=None):
 def do_sconscript(env, build_env, src_dir, out_dir):
     sconscript = src_dir.File('SConscript')
     print 'Reading {}'.format(sconscript)
+    # Swapping env and build_env here is a bit wacky. Doing so means that env is
+    # always the Environment that the SConscript should be building with, while
+    # build_env is the Environment we're using to put everything together.
     env.SConscript(sconscript,
                    {'env': build_env, 'build_env': env},
                    variant_dir=out_dir)