c-user: Clarify that confdefs.h is mandatory

This commit is contained in:
Sebastian Huber 2017-10-06 14:00:18 +02:00
parent 87e1929aea
commit 265cc700b4

View File

@ -21,14 +21,11 @@ initialization tasks, the task scheduling algorithm to be used, and the device
drivers in the application. drivers in the application.
Although this information is contained in data structures that are used by Although this information is contained in data structures that are used by
RTEMS at system initialization time, the data structures themselves should only RTEMS at system initialization time, the data structures themselves must not be
rarely to be generated by hand. RTEMS provides a set of macros system which generated by hand. RTEMS provides a set of macros system which provides a
provides a simple standard mechanism to automate the generation of these simple standard mechanism to automate the generation of these structures.
structures.
.. index:: confdefs.h .. index:: confdefs.h
.. index:: confdefs.h
.. index:: <rtems/confdefs.h>
.. index:: <rtems/confdefs.h> .. index:: <rtems/confdefs.h>
The RTEMS header file ``<rtems/confdefs.h>`` is at the core of the automatic The RTEMS header file ``<rtems/confdefs.h>`` is at the core of the automatic
@ -5090,18 +5087,3 @@ DESCRIPTION:
NOTES: NOTES:
The Go language support is experimental 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.