* documentation changes for the following patch.

* apparently missed in the 2002-03-04 merge?

2002-01-09  Graydon Hoare  <graydon@redhat.com>

	* compSched.cxx (scheduler_client): New member "name".
	(client_num_update): Hook up "N-name" attribute to client->name.
	* sid-visual-sched.tk (relate): Load subscription names into GUI,
	ghost subscriptions which have no output pins connected.
	* sid-sched.xml: Document new N-name attributes.
	* sid-sched.txt: Regenerate.

diff --git a/sid/component/sched/sid-sched.txt b/sid/component/sched/sid-sched.txt
index 317fdb3..ef35077 100644 (file)
--- a/sid/component/sched/sid-sched.txt
+++ b/sid/component/sched/sid-sched.txt
@@ -28,7 +28,12 @@ Functionality:
    |               | clients. Each "client"          |
    |               | corresponds to a set of "N-"    |
    |               | pins and attributes, with its   |
-   |               | own signalling schedule.        |
+   |               | own signalling schedule. During |
+   |               | configuration, the clients can  |
+   |               | also be named using the N-name  |
+   |               | attributes, which provides a    |
+   |               | more informative name for the   |
+   |               | scheduler's TK GUI              |
    |---------------+---------------------------------|
    |        timing | There is no global concept of   |
    |               | simulation time in sid.         |
@@ -266,6 +271,8 @@ Component Reference:
    |-------------------------+--------+--------+----------------+-------------||
    |num-clients              |setting |numeric |'0'             |configuration||
    |-------------------------+--------+--------+----------------+-------------||
+   |N-name                   |setting |-       |-               |configuration||
+   |-------------------------+--------+--------+----------------+-------------||
    |N-regular?               |setting |boolean |'0'             |subscription ||
    |-------------------------+--------+--------+----------------+-------------||
    |N-time                   |setting |numeric |'0'             |subscription ||

diff --git a/sid/component/sched/sid-sched.xml b/sid/component/sched/sid-sched.xml
index bc9d2f6..e647eaa 100644 (file)
--- a/sid/component/sched/sid-sched.xml
+++ b/sid/component/sched/sid-sched.xml
@@ -18,6 +18,7 @@
     <!-- attributes -->
     <defattribute name="state-snapshot" category="no category" legalvalues="opaque string" behaviors="state save/restore" />
     <defattribute name="num-clients" category="setting" legalvalues="numeric" defaultvalue="'0'" behaviors="configuration" />
+    <defattribute name="N-name" category="setting" behaviors="configuration" />
     <defattribute name="N-regular?" category="setting" legalvalues="boolean" defaultvalue="'0'" behaviors="subscription" />
     <defattribute name="N-time" category="setting" legalvalues="numeric" defaultvalue="'0'" behaviors="subscription" />
     <defattribute name="N-scale" category="setting" legalvalues="numeric fraction" defaultvalue="'1'" behaviors="subscription" />
@@ -59,10 +60,13 @@
     </modelling>
 
     <behavior name="configuration">
-      <p>When the <attribute>num-clients</attribute> is written-to, this component adjusts
-      its list of scheduler clients.  Each "client" corresponds to a
-      set of "N-" pins and attributes, with its own signalling
-      schedule.</p>
+      <p>When the <attribute>num-clients</attribute> is written-to,
+      this component adjusts its list of scheduler clients.  Each
+      "client" corresponds to a set of "N-" pins and attributes, with
+      its own signalling schedule. During configuration, the clients
+      can also be named using the <attribute>N-name</attribute>
+      attributes, which provides a more informative name for the
+      scheduler's TK GUI</p>
     </behavior>
 
     <behavior name="timing">