summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-05-28 08:11:03 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-05-28 08:11:03 +0200
commit1b05badfe7fe8d4e1d1fc73e6549d8cbf8acecf9 (patch)
tree6c765f220d34313ee28d346ae41c702d8c2c0dfe
parentspec: Add group for dynamic memory allocation (diff)
downloadrtems-central-1b05badfe7fe8d4e1d1fc73e6549d8cbf8acecf9.tar.bz2
spec: Add documentation interface domain
-rw-r--r--spec/doc/if/config-scheduler-clustered.yml4
-rw-r--r--spec/doc/if/config-scheduler-table.yml4
-rw-r--r--spec/doc/if/config-unlimited-objects.yml4
-rw-r--r--spec/doc/if/domain.yml13
-rw-r--r--spec/doc/if/mp-proxies.yml4
-rw-r--r--spec/doc/if/mrsp.yml4
-rw-r--r--spec/doc/if/scheduler-cbs.yml4
-rw-r--r--spec/doc/if/scheduler-concepts.yml4
-rw-r--r--spec/doc/if/scheduler-edf.yml4
-rw-r--r--spec/doc/if/scheduler-priority-simple.yml4
-rw-r--r--spec/doc/if/scheduler-priority.yml4
-rw-r--r--spec/doc/if/scheduler-smp-edf.yml4
-rw-r--r--spec/doc/if/scheduler-smp-priority-affinity.yml4
-rw-r--r--spec/doc/if/scheduler-smp-priority-simple.yml4
-rw-r--r--spec/doc/if/scheduler-smp-priority.yml4
-rw-r--r--spec/doc/if/terminate.yml4
16 files changed, 58 insertions, 15 deletions
diff --git a/spec/doc/if/config-scheduler-clustered.yml b/spec/doc/if/config-scheduler-clustered.yml
index f586e3a1..130bc06e 100644
--- a/spec/doc/if/config-scheduler-clustered.yml
+++ b/spec/doc/if/config-scheduler-clustered.yml
@@ -4,7 +4,9 @@ copyrights:
enabled-by: true
index-entries: []
interface-type: unspecified-group
-links: []
+links:
+- role: interface-placement
+ uid: domain
name: Clustered Scheduler Configuration
references:
c-user: ConfigurationSchedulersClustered
diff --git a/spec/doc/if/config-scheduler-table.yml b/spec/doc/if/config-scheduler-table.yml
index 0974e692..4b450acd 100644
--- a/spec/doc/if/config-scheduler-table.yml
+++ b/spec/doc/if/config-scheduler-table.yml
@@ -4,7 +4,9 @@ copyrights:
enabled-by: true
index-entries: []
interface-type: unspecified-group
-links: []
+links:
+- role: interface-placement
+ uid: domain
name: Configuration Step 3 - Scheduler Table
references:
c-user: ConfigurationSchedulerTable
diff --git a/spec/doc/if/config-unlimited-objects.yml b/spec/doc/if/config-unlimited-objects.yml
index 17c895f4..09c97581 100644
--- a/spec/doc/if/config-unlimited-objects.yml
+++ b/spec/doc/if/config-unlimited-objects.yml
@@ -4,7 +4,9 @@ copyrights:
enabled-by: true
index-entries: []
interface-type: unspecified-group
-links: []
+links:
+- role: interface-placement
+ uid: domain
name: Unlimited Objects
references:
c-user: ConfigUnlimitedObjects
diff --git a/spec/doc/if/domain.yml b/spec/doc/if/domain.yml
new file mode 100644
index 00000000..c98e0967
--- /dev/null
+++ b/spec/doc/if/domain.yml
@@ -0,0 +1,13 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+description: |
+ This interface domain contains interfaces to the documentation.
+enabled-by: true
+index-entries: []
+interface-type: domain
+links:
+- role: requirement-refinement
+ uid: /req/domains
+name: Documentation
+type: interface
diff --git a/spec/doc/if/mp-proxies.yml b/spec/doc/if/mp-proxies.yml
index 4012286a..0cdb9d95 100644
--- a/spec/doc/if/mp-proxies.yml
+++ b/spec/doc/if/mp-proxies.yml
@@ -4,7 +4,9 @@ copyrights:
enabled-by: true
index-entries: []
interface-type: unspecified-group
-links: []
+links:
+- role: interface-placement
+ uid: domain
name: Proxies
references:
c-user: MPCIProxies
diff --git a/spec/doc/if/mrsp.yml b/spec/doc/if/mrsp.yml
index 4c98d9c6..24abb9f4 100644
--- a/spec/doc/if/mrsp.yml
+++ b/spec/doc/if/mrsp.yml
@@ -4,7 +4,9 @@ copyrights:
enabled-by: true
index-entries: []
interface-type: unspecified-group
-links: []
+links:
+- role: interface-placement
+ uid: domain
name: Multiprocessor Resource Sharing Protocol (MrsP)
references:
c-user: MrsP
diff --git a/spec/doc/if/scheduler-cbs.yml b/spec/doc/if/scheduler-cbs.yml
index 06dd9204..4659e3ba 100644
--- a/spec/doc/if/scheduler-cbs.yml
+++ b/spec/doc/if/scheduler-cbs.yml
@@ -4,7 +4,9 @@ copyrights:
enabled-by: true
index-entries: []
interface-type: unspecified-group
-links: []
+links:
+- role: interface-placement
+ uid: domain
name: Constant Bandwidth Server Scheduling (CBS)
references:
c-user: SchedulerCBS
diff --git a/spec/doc/if/scheduler-concepts.yml b/spec/doc/if/scheduler-concepts.yml
index 40ae495a..34c08856 100644
--- a/spec/doc/if/scheduler-concepts.yml
+++ b/spec/doc/if/scheduler-concepts.yml
@@ -4,7 +4,9 @@ copyrights:
enabled-by: true
index-entries: []
interface-type: unspecified-group
-links: []
+links:
+- role: interface-placement
+ uid: domain
name: Scheduling Concepts
references:
c-user: RTEMSAPIClassicScheduler
diff --git a/spec/doc/if/scheduler-edf.yml b/spec/doc/if/scheduler-edf.yml
index bd8aa1bb..521c2d1f 100644
--- a/spec/doc/if/scheduler-edf.yml
+++ b/spec/doc/if/scheduler-edf.yml
@@ -4,7 +4,9 @@ copyrights:
enabled-by: true
index-entries: []
interface-type: unspecified-group
-links: []
+links:
+- role: interface-placement
+ uid: domain
name: Earliest Deadline First Scheduler
references:
c-user: SchedulerEDF
diff --git a/spec/doc/if/scheduler-priority-simple.yml b/spec/doc/if/scheduler-priority-simple.yml
index 53882bcd..a359d27a 100644
--- a/spec/doc/if/scheduler-priority-simple.yml
+++ b/spec/doc/if/scheduler-priority-simple.yml
@@ -4,7 +4,9 @@ copyrights:
enabled-by: true
index-entries: []
interface-type: unspecified-group
-links: []
+links:
+- role: interface-placement
+ uid: domain
name: Simple Priority Scheduler
references:
c-user: SchedulerPrioritySimple
diff --git a/spec/doc/if/scheduler-priority.yml b/spec/doc/if/scheduler-priority.yml
index f6b4264d..a01b9c95 100644
--- a/spec/doc/if/scheduler-priority.yml
+++ b/spec/doc/if/scheduler-priority.yml
@@ -4,7 +4,9 @@ copyrights:
enabled-by: true
index-entries: []
interface-type: unspecified-group
-links: []
+links:
+- role: interface-placement
+ uid: domain
name: Deterministic Priority Scheduler
references:
c-user: SchedulerPriority
diff --git a/spec/doc/if/scheduler-smp-edf.yml b/spec/doc/if/scheduler-smp-edf.yml
index 0b614545..3633ee9a 100644
--- a/spec/doc/if/scheduler-smp-edf.yml
+++ b/spec/doc/if/scheduler-smp-edf.yml
@@ -4,7 +4,9 @@ copyrights:
enabled-by: true
index-entries: []
interface-type: unspecified-group
-links: []
+links:
+- role: interface-placement
+ uid: domain
name: Earliest Deadline First SMP Scheduler
references:
c-user: SchedulerSMPEDF
diff --git a/spec/doc/if/scheduler-smp-priority-affinity.yml b/spec/doc/if/scheduler-smp-priority-affinity.yml
index ded97f5b..37d5ccfc 100644
--- a/spec/doc/if/scheduler-smp-priority-affinity.yml
+++ b/spec/doc/if/scheduler-smp-priority-affinity.yml
@@ -4,7 +4,9 @@ copyrights:
enabled-by: true
index-entries: []
interface-type: unspecified-group
-links: []
+links:
+- role: interface-placement
+ uid: domain
name: Arbitrary Processor Affinity Priority SMP Scheduler
references:
c-user: SchedulerSMPPriorityAffinity
diff --git a/spec/doc/if/scheduler-smp-priority-simple.yml b/spec/doc/if/scheduler-smp-priority-simple.yml
index 3ed6f096..dfc39bf1 100644
--- a/spec/doc/if/scheduler-smp-priority-simple.yml
+++ b/spec/doc/if/scheduler-smp-priority-simple.yml
@@ -4,7 +4,9 @@ copyrights:
enabled-by: true
index-entries: []
interface-type: unspecified-group
-links: []
+links:
+- role: interface-placement
+ uid: domain
name: Simple Priority SMP Scheduler
references:
c-user: SchedulerSMPPrioritySimple
diff --git a/spec/doc/if/scheduler-smp-priority.yml b/spec/doc/if/scheduler-smp-priority.yml
index a2f1716f..2bae07ee 100644
--- a/spec/doc/if/scheduler-smp-priority.yml
+++ b/spec/doc/if/scheduler-smp-priority.yml
@@ -4,7 +4,9 @@ copyrights:
enabled-by: true
index-entries: []
interface-type: unspecified-group
-links: []
+links:
+- role: interface-placement
+ uid: domain
name: Deterministic Priority SMP Scheduler
references:
c-user: SchedulerSMPPriority
diff --git a/spec/doc/if/terminate.yml b/spec/doc/if/terminate.yml
index c33499f0..a8f512dc 100644
--- a/spec/doc/if/terminate.yml
+++ b/spec/doc/if/terminate.yml
@@ -4,7 +4,9 @@ copyrights:
enabled-by: true
index-entries: []
interface-type: unspecified-group
-links: []
+links:
+- role: interface-placement
+ uid: domain
name: Announcing a Fatal Error
references:
c-user: Terminate