Skip to content

Commit 6b57606

Browse files
committed
Small additions/fixes to comments
1 parent 539b4cc commit 6b57606

3 files changed

Lines changed: 18 additions & 5 deletions

File tree

doc/AllDebugFlags.cfg

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
# PLEXIL looks for a file named Debug.cfg in the current working
1616
# directory.
1717

18+
# See the file DebugFlags.txt in this directory for a description of
19+
# some of these flags.
20+
1821
#AdapterConfiguration:clearThresholds
1922
#AdapterConfiguration:constructInterfaces
2023
#AdapterConfiguration:getCommandHandler

doc/DebugFlags.txt

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,20 @@ it has potential conflicts which need to be evaluated, or that it is
2020
actively blocked on such a conflict.
2121

2222
PlanDebug:conflicts - reports on the conflict resolution logic, for
23-
both assignment variables and mutexes. (NOTE: the PLEXIL Mutex is
24-
presently an undocumented new feature).
23+
both assignment variables and mutexes.
2524

2625
PlanDebug:failure - reports failed nodes and their failure type.
2726

2827
PlanDebug:macroStep - prints the start and end of each MACRO step in
2928
the plan's execution, giving its count, time, and number of candidates
30-
and pending, and number of commands that are executed (and aborted),
31-
if any.
29+
(see PlanDebug:candidates) and number of nodes pending (waiting for an
30+
assignment variable or mutex to be free), and number of commands that
31+
are executed (and aborted), if any.
3232

3333
PlanDebug:microStep - prints the start and end of each MICRO step in
3434
the plan's execution, giving its count, macro step reference, and
35-
number of candidates (see PlanDebug:candidates) and pending.
35+
number of candidates (see PlanDebug:candidates) and pending nodes (see
36+
PlanDebug:macroStep).
3637

3738
PlanDebug:outcome - reports the outcome of each node when it
3839
finishes. Same as Node:outcome but with a slightly different output
@@ -41,10 +42,16 @@ format.
4142
PlanDebug:transition - reports every node transition. Very similar to
4243
Node:transition, which also includes the time.
4344

45+
Test:testOutput - reports behavior as a simulation script is processed
46+
with the Test Executive.
47+
4448

4549
Notes
4650
-----
4751

52+
Several flags above refer to the PLEXIL Mutex, which is presently an
53+
undocumented new feature.
54+
4855
Redundancies between PlanDebug:* and Node* flags are intentional. The
4956
latter is an early Executive developer debugging tool, and is
5057
preserved for legacy. The newer PlanDebug:* flags are tailored more

examples/basic/Debug.cfg

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,6 @@
1313

1414
#Node:outcome
1515
#Node:transition
16+
17+
#Test:testOutput
18+

0 commit comments

Comments
 (0)