[rtems-docs commit] c-user: Clarify that confdefs.h is mandatory
sebh at rtems.org
Mon Oct 9 06:05:35 UTC 2017
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Fri Oct 6 14:00:18 2017 +0200
c-user: Clarify that confdefs.h is mandatory
c-user/configuring_a_system.rst | 24 +++---------------------
1 file changed, 3 insertions(+), 21 deletions(-)
diff --git a/c-user/configuring_a_system.rst b/c-user/configuring_a_system.rst
index 17c8a85..bed95cf 100644
@@ -21,14 +21,11 @@ initialization tasks, the task scheduling algorithm to be used, and the device
drivers in the application.
Although this information is contained in data structures that are used by
-RTEMS at system initialization time, the data structures themselves should only
-rarely to be generated by hand. RTEMS provides a set of macros system which
-provides a simple standard mechanism to automate the generation of these
+RTEMS at system initialization time, the data structures themselves must not be
+generated by hand. RTEMS provides a set of macros system which provides a
+simple standard mechanism to automate the generation of these structures.
.. index:: confdefs.h
-.. index:: confdefs.h
-.. index:: <rtems/confdefs.h>
.. index:: <rtems/confdefs.h>
The RTEMS header file ``<rtems/confdefs.h>`` is at the core of the automatic
@@ -5090,18 +5087,3 @@ DESCRIPTION:
The Go language support is experimental
-.. COMMENT: === Configuration Data Structures ===
-Configuration Data Structures
-It is recommended that applications be configured using ``<rtems/confdefs.h>``
-as it is simpler and insulates applications from changes in the underlying data
-structures. However, it is sometimes important to understand the data
-structures that are automatically filled in by the configuration parameters.
-This section describes the primary configuration data structures.
-If the user wishes to see the details of a particular data structure, they are
-are advised to look at the source code. After all, that is one of the
-advantages of RTEMS.
More information about the vc