about summary refs log tree commit diff stats
path: root/debug_translate
diff options
context:
space:
mode:
authorKartik Agaram <vc@akkartik.com>2019-09-07 10:20:44 -0700
committerKartik Agaram <vc@akkartik.com>2019-09-07 10:20:44 -0700
commit372a4259ae0c997102af53d4f6d9c35bda214e1d (patch)
tree8dd5d26a7a13be63774cb9e90e15ef3ea2d0d103 /debug_translate
parent571bf69fbc3bdfc82d2fa86391deb0d3b3b67560 (diff)
downloadmu-372a4259ae0c997102af53d4f6d9c35bda214e1d.tar.gz
5636
Diffstat (limited to 'debug_translate')
-rwxr-xr-xdebug_translate19
1 files changed, 11 insertions, 8 deletions
diff --git a/debug_translate b/debug_translate
index 39075aac..5f03fe0c 100755
--- a/debug_translate
+++ b/debug_translate
@@ -1,15 +1,18 @@
 #!/bin/sh
-# Translate SubX files with debug information.
+# Translate SubX files with debug information on Linux.
 #
 # Mu's core tooling has a gap:
-#   1. 'translate' can generate debug information, but syntax sugar passes
-#   (sigils and calls) have no C++ versions and take several minutes to run
-#   emulated.
-#   2. 'ntranslate' is fast, but you get no trace for runs and zero error-checking
-#   on the code emitted by sigils and calls. Which could still be buggy.
+#   0. The C++ translator 'subx translate' can generate debug information on
+#   Linux or BSD or Mac, but doesn't support any syntax sugar.
+#   1. The self-hosted translator 'translate' runs in emulated mode and can
+#   run on Linux or BSD or Mac. However, syntax sugar passes (sigils and
+#   calls) can be very slow to run emulated.
+#   2. The self-hosted translator 'ntranslate' runs natively on Linux. It is
+#   fast, but you get no trace for runs and zero error-checking on the code
+#   emitted by sigils and calls. Which could still be buggy.
 #
-# This script is a hack to get the best of both worlds. We run natively what
-# we must, and leverage as much debug information as possible. This arrangement
+# This script is a hack to get the best of all worlds. We run natively what we
+# must, and leverage as much debug information as possible. This arrangement
 # is snappy but requires Linux just like 'ntranslate'. You also are on your
 # own to mentally map desugared instructions in traces and error messages back
 # to the original sources.