[rtems commit] doxygen: Document CONFIGURE_INIT

Sebastian Huber sebh at rtems.org
Tue Feb 14 14:00:27 UTC 2023


Module:    rtems
Branch:    master
Commit:    c2756c1476b6da98fe6a3c140c4553882646f3db
Changeset: http://git.rtems.org/rtems/commit/?id=c2756c1476b6da98fe6a3c140c4553882646f3db

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Tue Feb 14 15:07:01 2023 +0100

doxygen: Document CONFIGURE_INIT

---

 cpukit/doxygen/appl-config.h | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/cpukit/doxygen/appl-config.h b/cpukit/doxygen/appl-config.h
index 2d4e8f7fb7..5c76761453 100644
--- a/cpukit/doxygen/appl-config.h
+++ b/cpukit/doxygen/appl-config.h
@@ -1,7 +1,7 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
 /*
- * Copyright (C) 2019, 2022 embedded brains GmbH (http://www.embedded-brains.de)
+ * Copyright (C) 2019, 2023 embedded brains GmbH (http://www.embedded-brains.de)
  * Copyright (C) 2010 Gedare Bloom
  * Copyright (C) 1988, 2022 On-Line Applications Research Corporation (OAR)
  *
@@ -2722,6 +2722,27 @@
  */
 #define CONFIGURE_EXTRA_TASK_STACKS
 
+/* Generated from spec:/acfg/if/init */
+
+/**
+ * @brief This configuration option is a boolean feature define.
+ *
+ * @anchor CONFIGURE_INIT
+ *
+ * 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.
+ *
+ * @par 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.
+ */
+#define CONFIGURE_INIT
+
 /* Generated from spec:/acfg/if/initial-extensions */
 
 /**



More information about the vc mailing list