summaryrefslogtreecommitdiffstats
path: root/c-user
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2023-02-14 16:06:12 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2023-02-14 16:14:47 +0100
commit79d05f58d743b9c642240465323d96bfbbcf5f37 (patch)
tree54c36a8f54d4f9c7561728e48fa7cdb40d21791a /c-user
parentc-user: Fix header file path (diff)
downloadrtems-docs-79d05f58d743b9c642240465323d96bfbbcf5f37.tar.bz2
c-user: Document CONFIGURE_INIT
Diffstat (limited to 'c-user')
-rw-r--r--c-user/config/general.rst38
-rw-r--r--c-user/config/intro.rst2
2 files changed, 38 insertions, 2 deletions
diff --git a/c-user/config/general.rst b/c-user/config/general.rst
index f135c6d..e175ca1 100644
--- a/c-user/config/general.rst
+++ b/c-user/config/general.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2020, 2023 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2022 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
@@ -253,6 +253,42 @@ The following constraints apply to this configuration option:
overflow an integer of type `uintptr_t
<https://en.cppreference.com/w/c/types/integer>`_.
+.. Generated from spec:/acfg/if/init
+
+.. raw:: latex
+
+ \clearpage
+
+.. index:: CONFIGURE_INIT
+
+.. _CONFIGURE_INIT:
+
+CONFIGURE_INIT
+--------------
+
+.. rubric:: CONSTANT:
+
+``CONFIGURE_INIT``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
+
+.. rubric:: DEFAULT CONFIGURATION:
+
+There is no default configuration associated with this configuration option.
+If ``<rtems/confdefs.h>`` is included and this configuration option is not
+defined, then only white space is included.
+
+.. rubric:: DESCRIPTION:
+
+While this configuration option is defined, when the ``<rtems/confdefs.h>``
+is included, the system settings defined by present application configuration
+options are statically allocated and initialized. All user provided
+application configuration options defined before the include of
+``<rtems/confdefs.h>`` are evaluated. They define the actual system
+settings.
+
.. Generated from spec:/acfg/if/initial-extensions
.. raw:: latex
diff --git a/c-user/config/intro.rst b/c-user/config/intro.rst
index 8de2765..e3d27e1 100644
--- a/c-user/config/intro.rst
+++ b/c-user/config/intro.rst
@@ -170,7 +170,7 @@ of these are as follows:
message queue will have up to twenty (20) messages of type ``struct
USER_MESSAGE``.
-- The ``CONFIGURE_INIT`` constant must be defined in order to make
+- The :ref:`CONFIGURE_INIT` constant must be defined in order to make
``<rtems/confdefs.h>`` instantiate the configuration data structures. This
can only be defined in one source file per application that includes
``<rtems/confdefs.h>`` or the symbol table will be instantiated multiple