[rtems-central commit] spec: Add "interface-ingroup-hidden" link role
Sebastian Huber
sebh at rtems.org
Fri May 28 06:11:22 UTC 2021
Module: rtems-central
Branch: master
Commit: 13e3d66ae2ab1a9a45d834edd34eb94e6938df13
Changeset: http://git.rtems.org/rtems-central/commit/?id=13e3d66ae2ab1a9a45d834edd34eb94e6938df13
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Fri May 28 07:11:45 2021 +0200
spec: Add "interface-ingroup-hidden" link role
This avoids orphaned items.
---
spec/rtems/clock/if/get-ticks-per-second-macro.yml | 2 ++
spec/rtems/clock/if/get-ticks-since-boot-macro.yml | 2 ++
spec/rtems/object/if/build-id-macro.yml | 2 ++
spec/rtems/object/if/build-name-macro.yml | 2 ++
spec/rtems/object/if/id-api-maximum-macro.yml | 2 ++
spec/rtems/object/if/id-api-minimum-macro.yml | 2 ++
spec/rtems/object/if/id-get-api-macro.yml | 2 ++
spec/rtems/object/if/id-get-class-macro.yml | 2 ++
spec/rtems/object/if/id-get-index-macro.yml | 2 ++
spec/rtems/object/if/id-get-node-macro.yml | 2 ++
spec/rtems/scheduler/if/get-processor-macro.yml | 2 ++
.../scheduler/if/get-processor-maximum-macro.yml | 2 ++
spec/spec/interface-ingroup-hidden.yml | 26 ++++++++++++++++++++++
specview.py | 4 ++--
14 files changed, 52 insertions(+), 2 deletions(-)
diff --git a/spec/rtems/clock/if/get-ticks-per-second-macro.yml b/spec/rtems/clock/if/get-ticks-per-second-macro.yml
index 6d00fb4..377c18e 100644
--- a/spec/rtems/clock/if/get-ticks-per-second-macro.yml
+++ b/spec/rtems/clock/if/get-ticks-per-second-macro.yml
@@ -13,6 +13,8 @@ interface-type: macro
links:
- role: interface-placement
uid: header
+- role: interface-ingroup-hidden
+ uid: group
name: rtems_clock_get_ticks_per_second
notes: null
params: []
diff --git a/spec/rtems/clock/if/get-ticks-since-boot-macro.yml b/spec/rtems/clock/if/get-ticks-since-boot-macro.yml
index b2f573c..f75693f 100644
--- a/spec/rtems/clock/if/get-ticks-since-boot-macro.yml
+++ b/spec/rtems/clock/if/get-ticks-since-boot-macro.yml
@@ -12,6 +12,8 @@ interface-type: macro
links:
- role: interface-placement
uid: header
+- role: interface-ingroup-hidden
+ uid: group
name: rtems_clock_get_ticks_since_boot
notes: null
params: []
diff --git a/spec/rtems/object/if/build-id-macro.yml b/spec/rtems/object/if/build-id-macro.yml
index ff999ce..1b09b90 100644
--- a/spec/rtems/object/if/build-id-macro.yml
+++ b/spec/rtems/object/if/build-id-macro.yml
@@ -14,6 +14,8 @@ interface-type: macro
links:
- role: interface-placement
uid: header
+- role: interface-ingroup-hidden
+ uid: group
name: rtems_build_id
notes: null
params:
diff --git a/spec/rtems/object/if/build-name-macro.yml b/spec/rtems/object/if/build-name-macro.yml
index ec8dd16..f924bfa 100644
--- a/spec/rtems/object/if/build-name-macro.yml
+++ b/spec/rtems/object/if/build-name-macro.yml
@@ -14,6 +14,8 @@ interface-type: macro
links:
- role: interface-placement
uid: header
+- role: interface-ingroup-hidden
+ uid: group
name: rtems_build_name
notes: null
params:
diff --git a/spec/rtems/object/if/id-api-maximum-macro.yml b/spec/rtems/object/if/id-api-maximum-macro.yml
index 173d68b..362feba 100644
--- a/spec/rtems/object/if/id-api-maximum-macro.yml
+++ b/spec/rtems/object/if/id-api-maximum-macro.yml
@@ -13,6 +13,8 @@ interface-type: macro
links:
- role: interface-placement
uid: header
+- role: interface-ingroup-hidden
+ uid: group
name: rtems_object_id_api_maximum
notes: null
params: []
diff --git a/spec/rtems/object/if/id-api-minimum-macro.yml b/spec/rtems/object/if/id-api-minimum-macro.yml
index 2f7cc68..b70af35 100644
--- a/spec/rtems/object/if/id-api-minimum-macro.yml
+++ b/spec/rtems/object/if/id-api-minimum-macro.yml
@@ -13,6 +13,8 @@ interface-type: macro
links:
- role: interface-placement
uid: header
+- role: interface-ingroup-hidden
+ uid: group
name: rtems_object_id_api_minimum
notes: null
params: []
diff --git a/spec/rtems/object/if/id-get-api-macro.yml b/spec/rtems/object/if/id-get-api-macro.yml
index dea6713..7de28b1 100644
--- a/spec/rtems/object/if/id-get-api-macro.yml
+++ b/spec/rtems/object/if/id-get-api-macro.yml
@@ -13,6 +13,8 @@ interface-type: macro
links:
- role: interface-placement
uid: header
+- role: interface-ingroup-hidden
+ uid: group
name: rtems_object_id_get_api
notes: null
params:
diff --git a/spec/rtems/object/if/id-get-class-macro.yml b/spec/rtems/object/if/id-get-class-macro.yml
index 9547b9b..ff1b7e8 100644
--- a/spec/rtems/object/if/id-get-class-macro.yml
+++ b/spec/rtems/object/if/id-get-class-macro.yml
@@ -13,6 +13,8 @@ interface-type: macro
links:
- role: interface-placement
uid: header
+- role: interface-ingroup-hidden
+ uid: group
name: rtems_object_id_get_class
notes: null
params:
diff --git a/spec/rtems/object/if/id-get-index-macro.yml b/spec/rtems/object/if/id-get-index-macro.yml
index 3b5b80d..02d90fb 100644
--- a/spec/rtems/object/if/id-get-index-macro.yml
+++ b/spec/rtems/object/if/id-get-index-macro.yml
@@ -13,6 +13,8 @@ interface-type: macro
links:
- role: interface-placement
uid: header
+- role: interface-ingroup-hidden
+ uid: group
name: rtems_object_id_get_index
notes: null
params:
diff --git a/spec/rtems/object/if/id-get-node-macro.yml b/spec/rtems/object/if/id-get-node-macro.yml
index fead805..718998a 100644
--- a/spec/rtems/object/if/id-get-node-macro.yml
+++ b/spec/rtems/object/if/id-get-node-macro.yml
@@ -13,6 +13,8 @@ interface-type: macro
links:
- role: interface-placement
uid: header
+- role: interface-ingroup-hidden
+ uid: group
name: rtems_object_id_get_node
notes: null
params:
diff --git a/spec/rtems/scheduler/if/get-processor-macro.yml b/spec/rtems/scheduler/if/get-processor-macro.yml
index 623f8c1..34fcc02 100644
--- a/spec/rtems/scheduler/if/get-processor-macro.yml
+++ b/spec/rtems/scheduler/if/get-processor-macro.yml
@@ -12,6 +12,8 @@ interface-type: macro
links:
- role: interface-placement
uid: ../../task/if/header
+- role: interface-ingroup-hidden
+ uid: group
name: rtems_scheduler_get_processor
notes: null
params: []
diff --git a/spec/rtems/scheduler/if/get-processor-maximum-macro.yml b/spec/rtems/scheduler/if/get-processor-maximum-macro.yml
index c3f1b8a..4f5c811 100644
--- a/spec/rtems/scheduler/if/get-processor-maximum-macro.yml
+++ b/spec/rtems/scheduler/if/get-processor-maximum-macro.yml
@@ -12,6 +12,8 @@ interface-type: macro
links:
- role: interface-placement
uid: ../../task/if/header
+- role: interface-ingroup-hidden
+ uid: group
name: rtems_scheduler_get_processor_maximum
notes: null
params: []
diff --git a/spec/spec/interface-ingroup-hidden.yml b/spec/spec/interface-ingroup-hidden.yml
new file mode 100644
index 0000000..a106891
--- /dev/null
+++ b/spec/spec/interface-ingroup-hidden.yml
@@ -0,0 +1,26 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+links:
+- role: spec-member
+ uid: root
+- role: spec-refinement
+ spec-key: role
+ spec-value: interface-ingroup-hidden
+ uid: link
+spec-description: null
+spec-example: null
+spec-info:
+ dict:
+ attributes: {}
+ description: |
+ It defines the interface hidden group membership role of links. This
+ role may be used to make an interface a group member and hide this
+ relationship in the documentation. An example is an optimized macro
+ implementation of a directive which has the same name as the
+ corresponding directive.
+ mandatory-attributes: all
+spec-name: Interface Hidden Group Membership Link Role
+spec-type: interface-ingroup-hidden
+type: spec
diff --git a/specview.py b/specview.py
index 836dfbd..cc57990 100755
--- a/specview.py
+++ b/specview.py
@@ -36,8 +36,8 @@ from rtemsspec.util import load_config
from rtemsspec.validation import Transition, TransitionMap
_CHILD_ROLES = [
- "requirement-refinement", "interface-ingroup", "interface-function",
- "validation", "appl-config-group-member"
+ "requirement-refinement", "interface-ingroup", "interface-ingroup-hidden",
+ "interface-function", "validation", "appl-config-group-member"
]
_PARENT_ROLES = ["interface-enumerator", "interface-placement"]
More information about the vc
mailing list