Opened on 04/02/20 at 08:32:10
Last modified on 07/21/22 at 07:56:02
#3923 assigned project
Add traceability information to the application configuration options
Reported by: | Sebastian Huber | Owned by: | Sebastian Huber |
---|---|---|---|
Priority: | normal | Milestone: | 7.1 |
Component: | doc | Version: | 6 |
Severity: | normal | Keywords: | qualification |
Cc: | Blocked By: | #3836 | |
Blocking: |
Description (last modified by Sebastian Huber)
There exists a specification of the application configuration options here:
https://git.rtems.org/rtems-central/tree/spec/acfg
For the RTEMS Qualification project we need traceability from the specification to the source code and vice versa. Methods and tools for this needs to be agreed on, documented, and implemented:
https://lists.rtems.org/pipermail/devel/2020-March/058744.html
https://lists.rtems.org/pipermail/devel/2020-March/058745.html
Document the configuration related specification items in the RTEMS Software Engineering manual along with the traceability approach.
Change History (6)
comment:1 Changed on 04/02/20 at 08:32:33 by Sebastian Huber
Blocked By: | 3836 added |
---|
comment:2 Changed on 04/02/20 at 08:35:41 by Sebastian Huber
Description: | modified (diff) |
---|
comment:3 Changed on 04/02/20 at 08:38:37 by Sebastian Huber
Description: | modified (diff) |
---|
comment:4 Changed on 07/21/22 at 07:52:00 by Sebastian Huber
Description: | modified (diff) |
---|---|
Milestone: | 6.1 → 7.1 |
comment:5 Changed on 07/21/22 at 07:55:34 by Sebastian Huber
Keywords: | qualifiation added |
---|
comment:6 Changed on 07/21/22 at 07:56:02 by Sebastian Huber
Keywords: | qualification added; qualifiation removed |
---|
Note: See
TracTickets for help on using
tickets.
The application configuration options (defines) are evaluated by header files in
cpukit/include/rtems/confdefs*
. Traceability from the specification to the source code and vice versa can be done via a Doxygen map file. However, this doesn't work for the application configuration since the evaluation of defines cannot be documented through Doxygen. We would need the ability to reference source code blocks in the specification.