aboutsummaryrefslogtreecommitdiffhomepage
path: root/generic/proof-shell.el
diff options
context:
space:
mode:
authorGravatar Hendrik Tews <hendrik@askra.de>2011-01-26 15:50:40 +0000
committerGravatar Hendrik Tews <hendrik@askra.de>2011-01-26 15:50:40 +0000
commit4d923ab403743c3c091ba3feec10757fae3b2fec (patch)
tree272e8ee75df5a33e3b6f3803d9d8a97b985a7a31 /generic/proof-shell.el
parente68f0f98fc69097fd9269a994ecdc5a04f498577 (diff)
- more info on the elements of proof-action-list; the COMMANDS
list in it should be concatenated with (mapconcat 'identity COMMANDS " "), which is not the case proof-shell-insert.
Diffstat (limited to 'generic/proof-shell.el')
-rw-r--r--generic/proof-shell.el20
1 files changed, 19 insertions, 1 deletions
diff --git a/generic/proof-shell.el b/generic/proof-shell.el
index 302b8400..02b024a0 100644
--- a/generic/proof-shell.el
+++ b/generic/proof-shell.el
@@ -40,7 +40,25 @@ The value is a list of lists of the form
(SPAN COMMANDS ACTION [DISPLAYFLAGS])
-which is the queue of things to do. The display flags are set
+which is the queue of things to do.
+
+SPAN is a region in the sources, where COMMANDS come from. Often,
+additional properties are recorded as properties of SPAN.
+
+COMMANDS is a list of strings, holding the text to be send to the
+prover. It might be the empty list is nothing needs to be sent to
+the prover, such as, for instance, for comments. Usually COMMANDS
+contains just 1 string, but it might also contains more elements.
+The text should be obtained with
+`(mapconcat 'identity COMMANDS \" \")', where the last argument
+is a space.
+
+ACTION is the callback to be invoked when this item has been
+processed by the prover. For normal scripting items it is
+`proof-done-advancing', for retract items
+`proof-done-retracting', but there are more possibilities.
+
+The DISPLAYFLAGS are set
for non-scripting commands or for when scripting should not
bother the user. They may include