summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--devel/requirements/3b_runner.xml13
-rw-r--r--devel/requirements/4_interface.xml6
2 files changed, 12 insertions, 7 deletions
diff --git a/devel/requirements/3b_runner.xml b/devel/requirements/3b_runner.xml
index 2391f54..a8c9b25 100644
--- a/devel/requirements/3b_runner.xml
+++ b/devel/requirements/3b_runner.xml
@@ -84,14 +84,19 @@
<title>Execute HorizonScript</title>
<section id="runner_execute_meta">
<title>Description / Priority</title>
- <para/>
+ <para>The system executes the instructions provided in the HorizonScript, in the specified order. The system reports progress, and all warnings and errors, to the listening agent. Once the system has finished, it reports the completion status to the listening agent.</para>
</section>
<section id="runner_execute_req">
<title>Functional Requirements</title>
- <formalpara>
- <title/>
- <para/>
+ <formalpara id="Runner.Execute">
+ <title>Runner.Execute</title>
+ <para>The system shall execute the instructions provided in the HorizonScript in the order described.</para>
</formalpara>
+ <formalpara id="Runner.Execute.Exception">
+ <title>Runner.Execute.Exception</title>
+ <para>The system shall report any exception encountered during execution to the listening agent, following the specification in <xref linkend="runner_agent"/>.</para>
+ </formalpara>
+
</section>
</section>
</section>
diff --git a/devel/requirements/4_interface.xml b/devel/requirements/4_interface.xml
index aca034c..9d3330b 100644
--- a/devel/requirements/4_interface.xml
+++ b/devel/requirements/4_interface.xml
@@ -97,8 +97,8 @@
</para>
</formalpara>
</section>
- <section id="ui_runner">
- <title>UI to Runner Interface</title>
- <para/>
+ <section id="runner_agent">
+ <title>Runner Listening Agent Interface</title>
+ <para>The Horizon Runner Listening Agent Interface is the interface used to communicate progress. The Horizon Runner will send messages to the Listening Agent using the interface defined here to note status messages, step completion, and any exceptions that occur during execution. The Listening Agent may be an external application (such as the Horizon UI), a logging system, or even a serial port or TTY monitored by the user. For this reason, automated parsing is a higher priority than sapient parsing, but sapient parsing still must be considered.</para>
</section>
</chapter>