This commit is contained in:
Kartik Agaram 2019-09-07 10:20:44 -07:00
parent 571bf69fbc
commit 372a4259ae
3 changed files with 14 additions and 10 deletions

View File

@ -1,15 +1,18 @@
#!/bin/sh #!/bin/sh
# Translate SubX files with debug information. # Translate SubX files with debug information on Linux.
# #
# Mu's core tooling has a gap: # Mu's core tooling has a gap:
# 1. 'translate' can generate debug information, but syntax sugar passes # 0. The C++ translator 'subx translate' can generate debug information on
# (sigils and calls) have no C++ versions and take several minutes to run # Linux or BSD or Mac, but doesn't support any syntax sugar.
# emulated. # 1. The self-hosted translator 'translate' runs in emulated mode and can
# 2. 'ntranslate' is fast, but you get no trace for runs and zero error-checking # run on Linux or BSD or Mac. However, syntax sugar passes (sigils and
# on the code emitted by sigils and calls. Which could still be buggy. # 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 # This script is a hack to get the best of all worlds. We run natively what we
# we must, and leverage as much debug information as possible. This arrangement # must, and leverage as much debug information as possible. This arrangement
# is snappy but requires Linux just like 'ntranslate'. You also are on your # 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 # own to mentally map desugared instructions in traces and error messages back
# to the original sources. # to the original sources.

View File

@ -1,5 +1,5 @@
#!/bin/sh #!/bin/sh
# Translate SubX using the self-hosted translator. # Translate SubX by running the self-hosted translator natively on Linux.
# #
# Possible knobs: # Possible knobs:
# Whether to run a phase natively or in emulated mode. # Whether to run a phase natively or in emulated mode.

View File

@ -1,5 +1,6 @@
#!/bin/sh #!/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: # Possible knobs:
# Whether to run a phase natively or in emulated mode. # Whether to run a phase natively or in emulated mode.