From 5a3cb76d38fa15ac8482be1d55be357594a8c54e Mon Sep 17 00:00:00 2001
From: Sebastian Huber <sebastian.huber@embedded-brains.de>
Date: Wed, 21 Apr 2021 10:49:36 +0200
Subject: c-user: Generate initialization manager docs

The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup.  The documentation was
transfered to interface specification items.  The documentation source
files were generated from the items by a script.

Update #3993.
---
 c-user/initialization/directives.rst | 68 +++++++++++++++++++++++++-----------
 1 file changed, 48 insertions(+), 20 deletions(-)

(limited to 'c-user/initialization/directives.rst')

diff --git a/c-user/initialization/directives.rst b/c-user/initialization/directives.rst
index 97dea46..ca5c9c2 100644
--- a/c-user/initialization/directives.rst
+++ b/c-user/initialization/directives.rst
@@ -1,41 +1,69 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
+.. Copyright (C) 2015, 2021 embedded brains GmbH (http://www.embedded-brains.de)
 .. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 
+.. This file is part of the RTEMS quality process and was automatically
+.. generated.  If you find something that needs to be fixed or
+.. worded better please post a report or patch to an RTEMS mailing list
+.. or raise a bug report:
+..
+.. https://www.rtems.org/bugs.html
+..
+.. For information on updating and regenerating please refer to the How-To
+.. section in the Software Requirements Engineering chapter of the
+.. RTEMS Software Engineering manual.  The manual is provided as a part of
+.. a release.  For development sources please refer to the online
+.. documentation at:
+..
+.. https://docs.rtems.org
+
+.. _InitializationManagerDirectives:
+
 Directives
 ==========
 
-This section details the Initialization Manager's directives.  A subsection is
-dedicated to each of this manager's directives and describes the calling
-sequence, related constants, usage, and status codes.
+This section details the directives of the Initialization Manager. A subsection
+is dedicated to each of this manager's directives and lists the calling
+sequence, parameters, description, return values, and notes of the directive.
+
+.. Generated from spec:/rtems/init/if/initialize-executive
 
 .. raw:: latex
 
-   \clearpage
+    \clearpage
 
+.. index:: rtems_initialize_executive()
 .. index:: initialize RTEMS
 .. index:: start multitasking
-.. index:: rtems_initialize_executive
 
-.. _rtems_initialize_executive:
+.. _InterfaceRtemsInitializeExecutive:
+
+rtems_initialize_executive()
+----------------------------
+
+Initializes the system and starts multitasking.
+
+.. rubric:: CALLING SEQUENCE:
+
+.. code-block:: c
+
+    void rtems_initialize_executive( void );
+
+.. rubric:: DESCRIPTION:
 
-INITIALIZE_EXECUTIVE - Initialize RTEMS
----------------------------------------
+Iterates through the system initialization linker set and invokes the
+registered handlers.  The final step is to start multitasking.
 
-CALLING SEQUENCE:
-    .. code-block:: c
+.. rubric:: NOTES:
 
-        void rtems_initialize_executive(void);
+Errors in the initialization sequence are usually fatal and lead to a system
+termination.
 
-DIRECTIVE STATUS CODES:
-    NONE - This function will not return to the caller.
+.. rubric:: CONSTRAINTS:
 
-DESCRIPTION:
-    Iterates through the system initialization linker set and invokes the
-    registered handlers.  The final step is to start multitasking.
+The following constraints apply to this directive:
 
-NOTES:
-    This directive should be called by :c:func:`boot_card()` only.
+* The directive should be called by :c:func:`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.
+* The directive will not return to the caller.
-- 
cgit v1.2.3