about summary refs log tree commit diff stats
path: root/subx/Readme.md
diff options
context:
space:
mode:
authorKartik Agaram <vc@akkartik.com>2019-04-27 21:33:26 -0700
committerKartik Agaram <vc@akkartik.com>2019-04-27 21:40:12 -0700
commitf539a27245d31f4ba3c90389dce1f5f4d372bd27 (patch)
tree63ad429ff673c9c0febef165b0dc0e93c8adaee8 /subx/Readme.md
parent62a71b89a88800c1966980db1b0ca01ef728c78e (diff)
downloadmu-f539a27245d31f4ba3c90389dce1f5f4d372bd27.tar.gz
5131
Rename '--map' to '--debug'.
Diffstat (limited to 'subx/Readme.md')
-rw-r--r--subx/Readme.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/subx/Readme.md b/subx/Readme.md
index 02867df4..15cb9972 100644
--- a/subx/Readme.md
+++ b/subx/Readme.md
@@ -41,8 +41,9 @@ messages.
 Emulated runs generate a trace that permits [time-travel debugging](https://github.com/akkartik/mu/blob/master/browse_trace/Readme.md).
 
   ```sh
-  $ ./subx --map translate examples/factorial.subx -o examples/factorial
-  $ ./subx --map --trace run examples/factorial
+  $ ./subx --debug translate examples/factorial.subx -o examples/factorial
+  saving address->label information to 'labels'
+  $ ./subx --debug --trace run examples/factorial
   saving trace to 'last_run'
   $ ../browse_trace/browse_trace last_run  # text-mode debugger UI
   ```
@@ -408,12 +409,12 @@ rudimentary but hopefully still workable toolkit:
 * As a further refinement, it is possible to render label names in the trace
   by adding a second flag to both the `translate` and `run` commands:
   ```
-  $ ./subx --map translate input.subx -o binary
-  $ ./subx --map --trace run binary arg1 arg2  2>trace
+  $ ./subx --debug translate input.subx -o binary
+  $ ./subx --debug --trace run binary arg1 arg2  2>trace
   ```
-  `subx --map translate` emits a mapping from label to address in a file
-  called `map`. `subx --map --trace run` reads in the `map` file at the start
-  and prints out any matching label name as it traces each instruction
+  `subx --debug translate` emits a mapping from label to address in a file
+  called `labels`. `subx --debug --trace run` reads in the `labels` file at
+  the start and prints out any matching label name as it traces each instruction
   executed.
 
   Here's a sample of what a trace looks like, with a few boxes highlighted: