From 372a4259ae0c997102af53d4f6d9c35bda214e1d Mon Sep 17 00:00:00 2001 From: Kartik Agaram Date: Sat, 7 Sep 2019 10:20:44 -0700 Subject: [PATCH] 5636 --- debug_translate | 19 +++++++++++-------- ntranslate | 2 +- translate | 3 ++- 3 files changed, 14 insertions(+), 10 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. diff --git a/ntranslate b/ntranslate index 4cc8e955..457fb1c9 100755 --- a/ntranslate +++ b/ntranslate @@ -1,5 +1,5 @@ #!/bin/sh -# Translate SubX using the self-hosted translator. +# Translate SubX by running the self-hosted translator natively on Linux. # # Possible knobs: # Whether to run a phase natively or in emulated mode. diff --git a/translate b/translate index caa3b375..88783c15 100755 --- a/translate +++ b/translate @@ -1,5 +1,6 @@ #!/bin/sh -# Translate SubX using the self-hosted translator. +# Translate SubX by running the self-hosted translator in emulated mode on +# Linux or BSD or Mac. # # Possible knobs: # Whether to run a phase natively or in emulated mode.