[soar] r14046 committed - - Updated release notes and TclSoarLib README

[so...@googlecode.com]

Revision: 14046
Author: mazzin
Date: Sun Jun 15 22:43:52 2014 UTC
Log: - Updated release notes and TclSoarLib README
http://code.google.com/p/soar/source/detail?r=14046

Modified:
/trunk/Release/docs/Release_Notes_9.3.3.txt
/trunk/SoarSuite/Tcl/TclSoarLib_README.txt

=======================================
--- /trunk/Release/docs/Release_Notes_9.3.3.txt Sat Jun 14 20:53:02 2014 UTC
+++ /trunk/Release/docs/Release_Notes_9.3.3.txt Sun Jun 15 22:43:52 2014 UTC
@@ -256,6 +256,15 @@
(8) Now has LSB support, which can facilitate compilation on certain
*nix system.

+==========
+Known Bugs
+==========
+
+(1) On some platforms, the SoarJavaDebugger may crash when exiting.
+
+See https://code.google.com/p/soar/issues/list for the current list of
issues
+and feature requests.
+
======================
Other Changes in 9.3.3
======================
@@ -472,8 +481,10 @@
different test agent, change the number of trials and control the amount
of information printed.

+-------------------------------------
+
=====================
-TclSoarLib Release Notes
+TclSoarLib
Author: Mazin Assanie
5/27/14
=====================
@@ -548,15 +559,8 @@
Known Bugs
==========

-1. If you call a tcl function from the command line that returns a list
as a
- result, it will only print one element from the list.
-
- For now, you can can get around this by enclosing the command in a
puts,
- for example:
-
- puts [info globals]
-
-2. Turn off tcl mode causes a crash on some systems. Don't do for now.
+1. Turning off tcl mode causes a crash on some systems. That option is
+ currently disabled as a result.

=======
Caveats
=======================================
--- /trunk/SoarSuite/Tcl/TclSoarLib_README.txt Sat Jun 14 20:53:08 2014 UTC
+++ /trunk/SoarSuite/Tcl/TclSoarLib_README.txt Sun Jun 15 22:43:52 2014 UTC
@@ -6,15 +6,15 @@

- Seamlessly turns Soar prompt into a Tcl prompt with a single command.
- Uses a combination of C++ and Tcl code.
- - Processes commands in embedded Tcl interpreters, which calls Soar
commands
+ - Processes commands in embedded Tcl interpreters, which calls Soar
commands
as needed.
- - Productions can make Tcl calls by writing "(exec tcl | <Tcl code> |)"
+ - Productions can make Tcl calls by writing "(exec tcl | <Tcl code> |)"
clauses
on the RHS of rules. Soar symbols and variables can be include in RHS
item.
-- Very simple installation process.
- - The user must simply have ActiveTcl 8.6 installed and the TclSoarlib
files
+- Very simple installation process.
+ - The user must simply have ActiveTcl 8.6 installed and the TclSoarlib
files
in the same directory as the latest Soar dll.
-- Provides Tcl capabilities to both local and remote clients, including the
+- Provides Tcl capabilities to both local and remote clients, including the
java-based C-Soar debugger.
- Processes Tcl commands from both the Soar command line and any files
sourced.
- Each agent has its own Tcl interpreter.
@@ -49,24 +49,24 @@
Building from Source Code
=========================

-1. Make sure ActiveTcl 8.6 is installed.
+1. Make sure ActiveTcl 8.6 is installed.
- http://www.activestate.com/activetcl/downloads
- We recommend that you use the default install location.

2. Download the SoarSuite source code from the wiki or check out the
SVN repository
- https://code.google.com/p/soar/wiki/Downloads
- - Follow the standard build instructions for your platform until you
get to
+ - Follow the standard build instructions for your platform until you
get to
the build step

-3. When you get to the compilation step, specify either the "all" or the
- "tclsoarlib" build target.
+3. When you get to the compilation step, specify either the "all" or the
+ "tclsoarlib" build target.

For example, on Windows:

% build all

- or
+ or

% build tclsoarlib

@@ -83,45 +83,45 @@

1. You cannot turn tcl on in a sourced file that has tcl code in it

-Soar cannot deal with such files because it does not load the tcl
interpreter
-until the source command completes. Future versions can remedy this
issue. A
-more immediate solution would be to have TclSoarLib automatically loaded on
+Soar cannot deal with such files because it does not load the tcl
interpreter
+until the source command completes. Future versions can remedy this
issue. A
+more immediate solution would be to have TclSoarLib automatically loaded on
Soar launch, if it exists.

2. Currently uses two aliasing mechanism

-Because the module wraps known soar commands, aliases are problematic.
For now
-TclSoarLib follows previous implementations and switches to its own alias
-system. When Tcl mode is turned on, aliases defined in alias.Tcl are used.
-Soar aliases previously defined will no longer be recognized until Tcl mode
+Because the module wraps known soar commands, aliases are problematic.
For now
+TclSoarLib follows previous implementations and switches to its own alias
+system. When Tcl mode is turned on, aliases defined in alias.Tcl are used.
+Soar aliases previously defined will no longer be recognized until Tcl mode
is turned off. Future versions can remedy this issue.

-3. Only one RHS Tcl call will produce output.
-
-Soar rhs commands "write" (and even something like "cmd echo") will always
-work. But only the last Tcl function called can produce output, for
example a
-"puts" command or a custom Tcl proc that produces output as a side effect.
-That said, all rhs Tcl calls do get executed, so they will do what they
are
-supposed to do, including perhaps writing output to a file. The problem is
-that the print output just doesn't get redirected to the right place,
despite
+3. Only one RHS Tcl call will produce output.
+
+Soar rhs commands "write" (and even something like "cmd echo") will always
+work. But only the last Tcl function called can produce output, for
example a
+"puts" command or a custom Tcl proc that produces output as a side effect.
+That said, all rhs Tcl calls do get executed, so they will do what they
are
+supposed to do, including perhaps writing output to a file. The problem is
+that the print output just doesn't get redirected to the right place,
despite
being produced.

-As a workaround, a user can make sure both that there is only one Tcl call
-which needs to produce output and that it comes after any other Tcl RHS
-actions.
+As a workaround, a user can make sure both that there is only one Tcl call
+which needs to produce output and that it comes after any other Tcl RHS
+actions.

-Future versions can remedy this issue, but it may require a different
+Future versions can remedy this issue, but it may require a different
implementation for rhs output.

4. Does not support Tk code

-Tk is a widget toolkit that many Tcl programs use to provide a GUI, for
+Tk is a widget toolkit that many Tcl programs use to provide a GUI, for
example the old Soar TSI debugger. Future versions can remedy this issue.

5. Tcl code that tries to do low-level Soar functions may or may not work.

-Creating and deleting a kernel will certainly not work. But other things
like
-creating an agent, other sml calls, other swig calls may work fine. This
+Creating and deleting a kernel will certainly not work. But other things
like
+creating an agent, other sml calls, other swig calls may work fine. This
caveat is inherent to the design of Tcl as a plug-in without a main event
loop.

6. Tcl code that requires a Tcl event loop may or may not work
@@ -129,5 +129,5 @@
One example is the Tcl "after" command. Future versions can remedy this
issue.

---------------
-
+
Questions: Contact Mazin Assanie (maz...@umich.edu)