[rtems-central commit] spec: Rename documentation in placement order

[Sebastian Huber]

Module:    rtems-central
Branch:    master
Commit:    290cf84c76bc203267065009c45335e32466e970
Changeset: http://git.rtems.org/rtems-central/commit/?id=290cf84c76bc203267065009c45335e32466e970

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Sun Oct 11 14:05:54 2020 +0200

spec: Rename documentation in placement order

---

 rtemsspec/interfacedoc.py                              |  2 +-
 rtemsspec/tests/spec-interface/gb.yml                  |  6 +++---
 spec/rtems/event/if/group.yml                          |  4 ++--
 spec/rtems/io/if/group.yml                             | 18 +++++++++---------
 .../{documentation-order.yml => placement-order.yml}   | 10 ++++++----
 5 files changed, 21 insertions(+), 19 deletions(-)

diff --git a/rtemsspec/interfacedoc.py b/rtemsspec/interfacedoc.py
index a2b548f..ed6a7e3 100644
--- a/rtemsspec/interfacedoc.py
+++ b/rtemsspec/interfacedoc.py
@@ -233,6 +233,6 @@ def generate(config: list, item_cache: ItemCache) -> None:
             if child["interface-type"] == "function":
                 items.append(child)
         items.sort(key=functools.partial(
-            _directive_key, list(group.parents("documentation-order"))))
+            _directive_key, list(group.parents("placement-order"))))
         _generate_introduction(doc_config["introduction-target"], group, items)
         _generate_directives(doc_config["directives-target"], group, items)
diff --git a/rtemsspec/tests/spec-interface/gb.yml b/rtemsspec/tests/spec-interface/gb.yml
index fc98b70..43cffe2 100644
--- a/rtemsspec/tests/spec-interface/gb.yml
+++ b/rtemsspec/tests/spec-interface/gb.yml
@@ -14,11 +14,11 @@ links:
   uid: other
 - role: interface-placement
   uid: h
-- role: documentation-order
+- role: placement-order
   uid: func4
-- role: documentation-order
+- role: placement-order
   uid: func2
-- role: documentation-order
+- role: placement-order
   uid: enum
 name: Group B
 type: interface
diff --git a/spec/rtems/event/if/group.yml b/spec/rtems/event/if/group.yml
index 704095c..73ebdb6 100644
--- a/spec/rtems/event/if/group.yml
+++ b/spec/rtems/event/if/group.yml
@@ -15,9 +15,9 @@ links:
   uid: header
 - role: interface-ingroup
   uid: ../../if/group
-- role: documentation-order
+- role: placement-order
   uid: send
-- role: documentation-order
+- role: placement-order
   uid: receive
 name: Event Manager
 text: |
diff --git a/spec/rtems/io/if/group.yml b/spec/rtems/io/if/group.yml
index 00bf730..3f32dd8 100644
--- a/spec/rtems/io/if/group.yml
+++ b/spec/rtems/io/if/group.yml
@@ -16,23 +16,23 @@ links:
   uid: header
 - role: interface-ingroup
   uid: ../../if/group
-- role: documentation-order
+- role: placement-order
   uid: register-driver
-- role: documentation-order
+- role: placement-order
   uid: unregister-driver
-- role: documentation-order
+- role: placement-order
   uid: initialize
-- role: documentation-order
+- role: placement-order
   uid: register-name
-- role: documentation-order
+- role: placement-order
   uid: open
-- role: documentation-order
+- role: placement-order
   uid: close
-- role: documentation-order
+- role: placement-order
   uid: read
-- role: documentation-order
+- role: placement-order
   uid: write
-- role: documentation-order
+- role: placement-order
   uid: control
 name: I/O Manager
 text: |
diff --git a/spec/spec/documentation-order.yml b/spec/spec/placement-order.yml
similarity index 59%
rename from spec/spec/documentation-order.yml
rename to spec/spec/placement-order.yml
index 475f492..9eecbdf 100644
--- a/spec/spec/documentation-order.yml
+++ b/spec/spec/placement-order.yml
@@ -7,7 +7,7 @@ links:
   uid: root
 - role: spec-refinement
   spec-key: role
-  spec-value: documentation-order
+  spec-value: placement-order
   uid: link
 spec-description: null
 spec-example: null
@@ -15,8 +15,10 @@ spec-info:
   dict:
     attributes: {}
     description: |
-      It defines the documentation order role of links.
+      This link role defines the placement order of items in a container item
+      (for example an interface function in a header file or a documentation
+      section).
     mandatory-attributes: all
-spec-name: Documentation Order Link Role
-spec-type: documentation-order-role
+spec-name: Placement Order Link Role
+spec-type: placement-order-role
 type: spec