Seventy-three files had a Doxygen block but no @ingroup line. Doxygen
documented them, but no group page listed them. The PCI headers, the
driver manager headers and 46 headers under include/rtems were affected.
Give each file the group of the component it belongs to. The seven
default file system files follow the table they fill. A file which
provides an entry of rtems_filesystem_operations_table joins LibIOFSOps.
A file which provides an entry of rtems_filesystem_file_handlers_r joins
LibIOFSHandler.
Every file in cpukit with a Doxygen block names a group. The files
malloc.h, todimpl.h and printk_plugin.c name two groups. The other
files name one.
Updates #5717.
Assisted-by: Claude:claude-opus-5 claude-code
Signed-off-by: Sebastian Huber <sebastian.huber@embedded-brains.de>
The header mqueue.h defined RTEMSImplPOSIXMessageQueue inside the guard
for _POSIX_MESSAGE_PASSING. Doxygen runs the preprocessor and nothing
defines that macro for it. The group therefore never existed, and the
17 files which name it fell out of the group graph.
Move the group definition above the guard. The declarations it encloses
stay inside the guard.
Updates #5717.
Assisted-by: Claude:claude-opus-5 claude-code
Signed-off-by: Sebastian Huber <sebastian.huber@embedded-brains.de>
The manager groups under RTEMSImplPOSIX used three naming schemes. Nine
groups used a POSIX_ prefix in upper case. Two used a mixed case name
with a Private suffix. None of them said that they hold an
implementation.
Rename each group to RTEMSImplPOSIX<Manager>. The titles and the briefs
stay. One @ingroup line in pthreadexit.c carried the group title after
the group name, which made Doxygen look for three more groups. Drop
that title.
Updates #5717.
Assisted-by: Claude:claude-opus-5 claude-code
Signed-off-by: Sebastian Huber <sebastian.huber@embedded-brains.de>
The POSIXAPI group is a child of RTEMSImpl. Its name said API, so a
reader could take it for a child of RTEMSAPI. It also did not follow
the RTEMSImpl naming scheme of its siblings.
Rename the group to RTEMSImplPOSIX. The title and the brief stay.
Updates #5717.
Assisted-by: Claude:claude-opus-5 claude-code
Signed-off-by: Sebastian Huber <sebastian.huber@embedded-brains.de>
A speciality of the RTEMS build system was the make preinstall step. It
copied header files from arbitrary locations into the build tree. The
header files were included via the -Bsome/build/tree/path GCC command
line option.
This has at least seven problems:
* The make preinstall step itself needs time and disk space.
* Errors in header files show up in the build tree copy. This makes it
hard for editors to open the right file to fix the error.
* There is no clear relationship between source and build tree header
files. This makes an audit of the build process difficult.
* The visibility of all header files in the build tree makes it
difficult to enforce API barriers. For example it is discouraged to
use BSP-specifics in the cpukit.
* An introduction of a new build system is difficult.
* Include paths specified by the -B option are system headers. This
may suppress warnings.
* The parallel build had sporadic failures on some hosts.
This patch removes the make preinstall step. All installed header
files are moved to dedicated include directories in the source tree.
Let @RTEMS_CPU@ be the target architecture, e.g. arm, powerpc, sparc,
etc. Let @RTEMS_BSP_FAMILIY@ be a BSP family base directory, e.g.
erc32, imx, qoriq, etc.
The new cpukit include directories are:
* cpukit/include
* cpukit/score/cpu/@RTEMS_CPU@/include
* cpukit/libnetworking
The new BSP include directories are:
* bsps/include
* bsps/@RTEMS_CPU@/include
* bsps/@RTEMS_CPU@/@RTEMS_BSP_FAMILIY@/include
There are build tree include directories for generated files.
The include directory order favours the most general header file, e.g.
it is not possible to override general header files via the include path
order.
The "bootstrap -p" option was removed. The new "bootstrap -H" option
should be used to regenerate the "headers.am" files.
Update #3254.
Sebastian Huber
Gedare Bloom
Joel Sherrill
Chris Johns