Skip to content

Commit 729a3c7

Browse files
committed
Slightly update Soar debugger intro
The average user will not run the jar without the run script included with Soar, and a plain `java -jar SoarJavaDebugger.jar` won't work, anyway, because the classpath and lib path have to be specified as well.
1 parent 35a04a1 commit 729a3c7

File tree

1 file changed

+13
-9
lines changed
  • docs/tutorials/IntroSoarDebugger

1 file changed

+13
-9
lines changed

docs/tutorials/IntroSoarDebugger/index.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ tags:
77

88
# Introduction to the Soar Debugger
99

10+
The Soar Java Debugger is distributed with Soar, and can be launched by
11+
double-clicking either `SoarJavaDebugger.bat` or `SoarJavaDebugger.sh` in the
12+
root directory of Soar.
13+
1014
## Overview
1115

1216
With Soar 8.6 we made a new method for interfacing into Soar based around SML
@@ -52,8 +56,8 @@ you can use this simple mechanism to watch a particular part of working memory (
5256
printing the input link) while you step forward.
5357

5458
The default layout that you started with uses a tree view for the main trace window.
55-
To see this in action press the "watch 5" button and then type `run 20` again at the
56-
command prompt.
59+
To see this in action press the "watch 5" button and then type `run 20` again at
60+
the command prompt.
5761

5862
This should result in a display like this:
5963

@@ -302,20 +306,20 @@ debugger you wished you had. If you find yourself wanting to do this, please dro
302306
us a line (<soar-sml-list@umich.edu>) before you start coding and we'll help you
303307
along and hopefully share in the results.
304308

309+
<!-- TODO: what Soar kernel bug? Has that been fixed? Do we have a memory leak? -->
310+
305311
If you run Soar from within the debugger for long periods of time (i.e. tens of
306312
thousands of decision cycles), you may notice that memory usage grows over time.
307313
In fact, eventually, Soar will start running very slowly and then not at all. This
308314
is because the Java virtual machine is running out of heap memory. The increasing
309315
memory usage is actually because of a very old Soar kernel bug. As a workaround,
310316
you can tell Java to allow more memory to be used by using the `--Xmx` command line
311-
switch for Java. For example, to tell Java to use up to 256 megabytes for the heap,
312-
you would do this:
313-
314-
java.exe --Xmx256m --jar SoarJavaDebugger.jar
317+
switch for Java. For example, to tell Java to use up to 256 megabytes for the
318+
heap, you would would add a `--Xmx256m` parameter. This parameter should be added
319+
after the `java` command in the `SoarJavaDebugger.sh` or after the `javaw` command
320+
in the `SoarJavaDebugger.bat` file shipped with Soar.
315321

316-
On Windows you can use javaw.exe if you prefer. This and other `--X` options are
317-
non-standard and may not exist on non-Sun JVMs. Also, note that the default value
318-
is only `64m` (64 megabytes).
322+
This and other `--X` options are non-standard and may not exist on non-Sun JVMs.
319323

320324
## Design Principles
321325

0 commit comments

Comments
 (0)