spec: Update /rtems/init/* and /rtems/fatal/* docs

4 files changed, 28 insertions, 49 deletions

diff --git a/spec/rtems/init/constraint/directive-ctx-boot.yml b/spec/rtems/init/constraint/directive-ctx-boot.yml
new file mode 100644
index 00000000..f313b888
--- /dev/null
+++ b/spec/rtems/init/constraint/directive-ctx-boot.yml
@@ -0,0 +1,10 @@
+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: []
+rationale: null
+scope: user
+text: |
+  The directive should be called by ${/bsp/if/boot-card:/name} only.
+type: constraint
diff --git a/spec/rtems/init/if/group.yml b/spec/rtems/init/if/group.yml
index a9b39963..25537375 100644
--- a/spec/rtems/init/if/group.yml
+++ b/spec/rtems/init/if/group.yml
@@ -1,10 +1,13 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This group contains directives to initialize and shutdown the RTEMS
-  executive.
+  The Initialization Manager is responsible for initializing the system.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: null
+- Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+description: |
+  The system initialization includes the initialization of the Board Support
+  Package, RTEMS, device drivers, the root filesystem, and the application.
+  The ${../../fatal/if/group:/name} is responsible for the system shutdown.
 enabled-by: true
 identifier: RTEMSAPIClassicInit
 index-entries: []
@@ -14,8 +17,7 @@ links:
   uid: header
 - role: interface-ingroup
   uid: ../../if/group
-name: Initialization and Shutdown
+name: Initialization Manager
 text: |
-  The Classic API shall provide an interface to the Initialization and Shutdown
-  Manager.
+  The Classic API shall provide an interface to the Initialization Manager.
 type: interface
diff --git a/spec/rtems/init/if/initialize-executive.yml b/spec/rtems/init/if/initialize-executive.yml
index 3e0095b2..158bb0f8 100644
--- a/spec/rtems/init/if/initialize-executive.yml
+++ b/spec/rtems/init/if/initialize-executive.yml
@@ -14,19 +14,23 @@ description: |
   Iterates through the system initialization linker set and invokes the
   registered handlers.  The final step is to start multitasking.
 enabled-by: true
-index-entries: []
+index-entries:
+- initialize RTEMS
+- start multitasking
 interface-type: function
 links:
 - role: interface-placement
   uid: header
 - role: interface-ingroup
   uid: group
+- role: constraint
+  uid: ../constraint/directive-ctx-boot
+- role: constraint
+  uid: /constraint/directive-no-return
 name: rtems_initialize_executive
 notes: |
-  This directive should be called by boot_card() only.
-
-  This directive does not return to the caller.  Errors in the initialization
-  sequence are usually fatal and lead to a system termination.
+  Errors in the initialization sequence are usually fatal and lead to a system
+  termination.
 params: []
 return:
   return: null
diff --git a/spec/rtems/init/if/shutdown-executive.yml b/spec/rtems/init/if/shutdown-executive.yml
deleted file mode 100644
index 7679b1a2..00000000
--- a/spec/rtems/init/if/shutdown-executive.yml
+++ /dev/null
@@ -1,37 +0,0 @@
-SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: |
-  Shuts down the RTEMS environment.
-copyrights:
-- Copyright (C) 2015, 2020 embedded brains GmbH (http://www.embedded-brains.de)
-- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-definition:
-  default:
-    attributes: ${../../basedefs/if/no-return:/name}
-    body: null
-    params:
-    - ${/c/if/uint32_t:/name} ${.:/params[0]/name}
-    return: void
-  variants: []
-description: |
-  The invocation of this directive results in the RTEMS environment being
-  shutdown and multitasking halted.  The system is terminated with a fatal
-  source of RTEMS_FATAL_SOURCE_EXIT and the specified result code.
-enabled-by: true
-index-entries: []
-interface-type: function
-links:
-- role: interface-placement
-  uid: header
-- role: interface-ingroup
-  uid: group
-name: rtems_shutdown_executive
-notes: |
-  This directive does not return to the caller.
-params:
-- description: is the result code.
-  dir: null
-  name: result
-return:
-  return: null
-  return-values: []
-type: interface