[rtems-central commit] spec: Add documentation interface domain
Sebastian Huber
sebh at rtems.org
Fri May 28 06:11:22 UTC 2021
Module: rtems-central
Branch: master
Commit: 1b05badfe7fe8d4e1d1fc73e6549d8cbf8acecf9
Changeset: http://git.rtems.org/rtems-central/commit/?id=1b05badfe7fe8d4e1d1fc73e6549d8cbf8acecf9
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Fri May 28 08:11:03 2021 +0200
spec: Add documentation interface domain
---
spec/doc/if/config-scheduler-clustered.yml | 4 +++-
spec/doc/if/config-scheduler-table.yml | 4 +++-
spec/doc/if/config-unlimited-objects.yml | 4 +++-
spec/doc/if/domain.yml | 13 +++++++++++++
spec/doc/if/mp-proxies.yml | 4 +++-
spec/doc/if/mrsp.yml | 4 +++-
spec/doc/if/scheduler-cbs.yml | 4 +++-
spec/doc/if/scheduler-concepts.yml | 4 +++-
spec/doc/if/scheduler-edf.yml | 4 +++-
spec/doc/if/scheduler-priority-simple.yml | 4 +++-
spec/doc/if/scheduler-priority.yml | 4 +++-
spec/doc/if/scheduler-smp-edf.yml | 4 +++-
spec/doc/if/scheduler-smp-priority-affinity.yml | 4 +++-
spec/doc/if/scheduler-smp-priority-simple.yml | 4 +++-
spec/doc/if/scheduler-smp-priority.yml | 4 +++-
spec/doc/if/terminate.yml | 4 +++-
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 f586e3a..130bc06 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 0974e69..4b450ac 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 17c895f..09c9758 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 0000000..c98e096
--- /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 4012286..0cdb9d9 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 4c98d9c..24abb9f 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 06dd920..4659e3b 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 40ae495..34c0885 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 bd8aa1b..521c2d1 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 53882bc..a359d27 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 f6b4264..a01b9c9 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 0b61454..3633ee9 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 ded97f5..37d5ccf 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 3ed6f09..dfc39bf 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 a2f1716..2bae07e 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 c33499f..a8f512d 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
More information about the vc
mailing list