#3706 accepted task

Create a hierarchy of RTEMS software components using Doxygen groups

Reported by: Sebastian Huber Owned by: Sebastian Huber
Priority: normal Milestone: 6.1
Component: doc Version: 6
Severity: normal Keywords: qualification
Cc: Blocked By: #3704
Blocking: #3705, #3707

Description (last modified by Sebastian Huber)

Create a hierarchy of RTEMS software components using Doxygen groups. Review the existing Doxygen groups (software components) first.

https://docs.rtems.org/doxygen/branches/master/modules.html

Grouping should be done by at BSP level architecture and then by BSP.

There should be a device driver group with subgroups for each device class and specific device drivers, e.g. a BSP-specific device driver belongs to a device class and BSP.

There should be groups for APIs, file systems, support libraries, super core, etc.

  • Board Support Packages
  • Device Drivers
    • Block Devices
      • Block Device Buffer Management
      • Block Device Disk Management
      • Block Device Management
        • XYZ Block Device
      • Block Device Partition Management
    • Cache
      • XYZ Cache Support
    • Console
      • Termios
        • XYZ Driver
    • Framebuffer
      • XYZ Driver
    • I2C
      • Bus Driver
        • XYZ Driver
      • Device Driver
        • XYZ Driver
    • Legacy I2C
    • Legacy Network
    • RTC
      • XYZ Driver
    • Serial Mouse
      • XYZ Driver
    • SPI
      • Bus Driver
        • XYZ Driver
      • Device Driver
        • XYZ Driver
  • API
    • Classic
      • Tasks
    • Dynamic Loading
    • File Systems
    • Memory Management
    • Shell
    • Tracing
      • Event Recording
      • Capture Engine
  • Internal
    • C Library Support
    • POSIX
    • Shell
    • Super Core
      • Thread Handler
      • CPU
        • ARM

Change History (67)

comment:1 Changed on Feb 26, 2019 at 1:28:28 PM by Sebastian Huber

Blocking: 3707 added

comment:2 Changed on Feb 26, 2019 at 1:30:45 PM by Sebastian Huber

Status: assignedaccepted

comment:3 Changed on Mar 4, 2019 at 6:54:58 AM by Sebastian Huber <sebastian.huber@…>

In 212663be/rtems:

bsps: Adjust architecture Doxygen groups

  • Use CamelCase as it is not used in our C code. Enables simple search and replace.
  • Prefix with "RTEMS" to aid deployment and integration. It aids searching and sorting.

Update #3706.

comment:4 Changed on Mar 4, 2019 at 6:55:01 AM by Sebastian Huber <sebastian.huber@…>

In 631ccd7/rtems:

bsp/altera-cyclone-v: Adjust Doxygen groups

Update #3706

comment:5 Changed on Mar 8, 2019 at 7:02:01 AM by Sebastian Huber <sebastian.huber@…>

In c991eeec/rtems:

bsps: Adjust bsp.h Doxygen groups

Update #3706.

comment:6 Changed on Mar 8, 2019 at 7:02:05 AM by Sebastian Huber <sebastian.huber@…>

In 828276b/rtems:

bsps: Adjust shared Doxygen groups

Update #3706.

comment:7 Changed on Mar 8, 2019 at 7:02:08 AM by Sebastian Huber <sebastian.huber@…>

In 15359bb/rtems:

bsps/arm: Adjust CMSIS Doxygen groups

Update #3706.

comment:8 Changed on Mar 8, 2019 at 7:02:11 AM by Sebastian Huber <sebastian.huber@…>

In f3db3835/rtems:

bsp/altera-cyclone-v: Add Doxygen groups

Add Doxygen groups for contributed code which would otherwise end up at
the top level.

Update #3706.

comment:9 Changed on Mar 8, 2019 at 7:02:14 AM by Sebastian Huber <sebastian.huber@…>

In cbf773d3/rtems:

bsp/atsam: Add Doxygen groups

Add Doxygen groups for contributed code which would otherwise end up at
the top level (about 178 groups).

Update #3706.

comment:10 Changed on Mar 8, 2019 at 7:02:17 AM by Sebastian Huber <sebastian.huber@…>

In 529b5868/rtems:

bsps: Adjust umon Doxygen groups

Update #3706.

comment:11 Changed on Mar 13, 2019 at 9:15:25 AM by Sebastian Huber

Description: modified (diff)

comment:12 Changed on Mar 26, 2019 at 10:28:40 AM by Sebastian Huber <sebastian.huber@…>

In 40d15f5/rtems:

score: Add implementation top-level group

Update #3706.

comment:13 Changed on Mar 26, 2019 at 10:28:44 AM by Sebastian Huber <sebastian.huber@…>

In 5526527e/rtems:

score: Rename ScoreCPU Doxygen group

Update #3706.

comment:14 Changed on Mar 26, 2019 at 10:28:48 AM by Sebastian Huber <sebastian.huber@…>

In 5a19915/rtems:

score: Add example CPU architecture group

Update #3706.

comment:15 Changed on Mar 26, 2019 at 10:28:51 AM by Sebastian Huber <sebastian.huber@…>

In abec398/rtems:

score: Add ARM CPU architecture group

Update #3706.

comment:16 Changed on Apr 2, 2019 at 5:31:55 AM by Andreas Dachsberger <andreas.dachsberger@…>

In eca13a8f/rtems:

doxygen: score: Add Blackfin CPU architecture group

Update #3706.

comment:17 Changed on Apr 2, 2019 at 5:31:58 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 40b90a08/rtems:

doxygen: score: Add Epiphany CPU architecture group

Update #3706.

comment:18 Changed on Apr 2, 2019 at 5:32:03 AM by Andreas Dachsberger <andreas.dachsberger@…>

In d670ef9/rtems:

doxygen: score: Add i386 CPU architecture group

Update #3706.

comment:19 Changed on Apr 2, 2019 at 5:32:07 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 9fa3561b/rtems:

doxygen: score: Add lm32 CPU architecture group

Update #3706.

comment:20 Changed on Apr 2, 2019 at 5:32:11 AM by Andreas Dachsberger <andreas.dachsberger@…>

In ee38c54/rtems:

doxygen: score: Change no_cpu architecture group

Groups CPUContext and CPUInterrupt are now defined with a unique name
for this architecture group.
Update #3706.

comment:21 Changed on Apr 2, 2019 at 5:32:15 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 0be1e54/rtems:

doxygen: score: Add m68k CPU architecture group

Update #3706.

comment:22 Changed on Apr 2, 2019 at 5:32:19 AM by Andreas Dachsberger <andreas.dachsberger@…>

In f2e282d/rtems:

doxygen: score: Add Moxie CPU architecture group

Update #3706.

comment:23 Changed on Apr 2, 2019 at 5:32:22 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 92c2db64/rtems:

doxygen: score: Add nios2 CPU architecture group

Update #3706.

comment:24 Changed on Apr 2, 2019 at 5:32:26 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 39594416/rtems:

doxygen: score: Add or1k CPU architecture group

Update #3706.

comment:25 Changed on Apr 2, 2019 at 5:32:29 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 6ddbcbc/rtems:

doxygen: score: Add powerpc CPU architecture group

Update #3706.

comment:26 Changed on Apr 2, 2019 at 5:32:32 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 71f9098/rtems:

doxygen: score: Add RISC-V CPU architecture group

Update #3706.

comment:27 Changed on Apr 2, 2019 at 5:32:35 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 2b37eca5/rtems:

doxygen: score: Add SuperH CPU architecture group

Update #3706.

comment:28 Changed on Apr 2, 2019 at 5:32:38 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 25afa79/rtems:

doxygen: score: Add SPARC CPU architecture group

Update #3706.

comment:29 Changed on Apr 2, 2019 at 5:32:42 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 2a50f87/rtems:

doxygen: score: Add SPARC64 CPU architecture group

Update #3706.

comment:30 Changed on Apr 2, 2019 at 5:32:45 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 9f8af67/rtems:

doxygen: score: Add V850 CPU architecture group

Update #3706.

comment:31 Changed on Apr 2, 2019 at 5:32:48 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 95c7603/rtems:

doxygen: score: Add x86-64 CPU architecture group

Update #3706.

comment:32 Changed on Apr 2, 2019 at 5:32:52 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 69d6671f/rtems:

doxygen: Reviewed cpukit/include/rtems/score

Update #3706.

comment:33 Changed on Apr 2, 2019 at 5:32:55 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 7a722e7/rtems:

doxygen: Reviewed cpukit/include/rtems/rtems

Update #3706.

comment:34 Changed on Apr 2, 2019 at 5:32:59 AM by Andreas Dachsberger <andreas.dachsberger@…>

In b86148a/rtems:

doxygen: Reviewed cpukit/include/rtems/posix

Update #3706.

comment:35 Changed on Apr 2, 2019 at 5:33:02 AM by Andreas Dachsberger <andreas.dachsberger@…>

In b07c721/rtems:

doxygen: Restructured cpukit/include/rtems/rtems

Update #3706.

comment:36 Changed on Apr 2, 2019 at 5:33:05 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 493c1e8/rtems:

doxygen: score: Put ARM Co-Processor 15 group in ARM

Update #3706.

comment:37 Changed on Apr 2, 2019 at 5:33:08 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 5342261/rtems:

doxygen: Added groups to IO library

Update #3706.

comment:38 Changed on Apr 2, 2019 at 5:33:12 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 058f637/rtems:

doxygen: score: Added ScoreRWLock to Score group

Update #3706.

comment:39 Changed on Apr 4, 2019 at 6:27:42 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 6644867/rtems:

doxygen: User Extensions Implementation group now in Internal->Classic

Update #3706.

comment:40 Changed on Apr 4, 2019 at 6:27:46 AM by Andreas Dachsberger <andreas.dachsberger@…>

In ff1f374/rtems:

doxygen: Added Mainpage to RTEMSAPIClassic

Update #3706.

comment:41 Changed on Apr 4, 2019 at 6:27:49 AM by Andreas Dachsberger <andreas.dachsberger@…>

In b7927ef/rtems:

doxygen: Added further groups to RTEMSAPI

Update #3706.

Associativity Routines, BSD Compatibility Support now part of
RTEMSAPI

comment:42 Changed on Apr 4, 2019 at 6:27:53 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 0f02e6f/rtems:

doxygen: Added toplevel group for device drivers

Update #3706.

comment:43 Changed on Apr 4, 2019 at 6:27:56 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 529d251b/rtems:

doxygen: Added libmisc group and libmisc mouse group

Update #3706.

@ingroup for these groups already existed, but no @defgroup

Further restructuring necessary

comment:44 Changed on Apr 4, 2019 at 6:27:59 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 1964b268/rtems:

doxygen: Added subgroup Generic to BSP->SPARC64

Update #3706.

comment:45 Changed on Apr 4, 2019 at 6:28:03 AM by Andreas Dachsberger <andreas.dachsberger@…>

In b2b7b58e/rtems:

doxygen: Added Management to Example CPU Architecture

Update #3706.

comment:46 Changed on Apr 4, 2019 at 6:28:07 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 333bead/rtems:

doxygen: Removed XXX group

Update #3706.

Content was added to Classic Barrier Implementation

comment:47 Changed on Apr 4, 2019 at 6:28:11 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 4b841b3/rtems:

doxygen: Added some subgroups to IO Library

Update #3706.

Types and Mount, IO Internal, Kernel Print Support

comment:48 Changed on Apr 4, 2019 at 6:28:14 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 6b23763/rtems:

doxygen: Added Frame Buffer Device Driver Interface to Device Drivers

Update #3706.

comment:49 Changed on Apr 4, 2019 at 6:28:18 AM by Andreas Dachsberger <andreas.dachsberger@…>

In e78e7fe0/rtems:

doxygen: Added Version to API->Classic

Update #3706.

comment:50 Changed on Apr 4, 2019 at 6:28:21 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 7cb1c2b0/rtems:

doxygen: Added I2C Driver to Device Drivers

Update #3706.

comment:51 Changed on Apr 4, 2019 at 6:28:25 AM by Andreas Dachsberger <andreas.dachsberger@…>

In b6b00917/rtems:

doxygen: Added some subgroups to API and IO

I2C library, Media Manager and Profiling Support

Update #3706.

comment:52 Changed on Apr 4, 2019 at 6:28:29 AM by Andreas Dachsberger <andreas.dachsberger@…>

In f91da319/rtems:

doxygen: Put C Library Support and POSIX in Internal

Update #3706.

comment:53 Changed on Apr 4, 2019 at 6:28:32 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 38a3b61/rtems:

doxygen: Put SPI Driver into group Device Drivers

Update #3706.

comment:54 Changed on Apr 4, 2019 at 6:28:36 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 2a56a1cf/rtems:

doxygen: Real Time Clock Time of Day API Definition in BSP->Shared

Update #3706.

comment:55 Changed on Apr 4, 2019 at 6:28:39 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 885c9a70/rtems:

doxygen: Put Print Support in IO

Update #3706.

comment:56 Changed on Apr 4, 2019 at 6:28:43 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 2bc058d/rtems:

doxygen: Put Real-Timer Clock Driver Interface into group Device Drivers

Update #3706.

comment:57 Changed on Apr 4, 2019 at 6:28:47 AM by Andreas Dachsberger <andreas.dachsberger@…>

In b8cff58/rtems:

doxygen: Benchmark Timer Driver Interface now in Device Drivers

Update #3706.

comment:58 Changed on Apr 4, 2019 at 6:28:50 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 74bfbc1f/rtems:

doxygen: Time Test 27 now in Device Drivers

Update #3706.

comment:59 Changed on Apr 4, 2019 at 6:28:54 AM by Andreas Dachsberger <andreas.dachsberger@…>

In bd675f39/rtems:

doxygen: Mouse now in Device Drivers

Update #3706.

comment:60 Changed on Apr 4, 2019 at 6:28:58 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 7e5ed6b/rtems:

doxygen: Print Support now in API->IO

Update #3706.

comment:61 Changed on Apr 4, 2019 at 6:29:01 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 7155b5bc/rtems:

doxygen: Zero and Null Device Drivers now in Device Drivers

Update #3706.

comment:62 Changed on Apr 4, 2019 at 6:29:05 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 57a076cd/rtems:

doxygen: Added subclasses to API

Update #3706.

RTEMS Application Loader, RTEMS Runtime Link Editor, Status Checks
and Test Support

comment:63 Changed on Apr 4, 2019 at 6:29:09 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 51f8d73b/rtems:

doxygen: Added inttypes.h to Print Support

Update #3706.

comment:64 Changed on Apr 4, 2019 at 6:29:13 AM by Andreas Dachsberger <andreas.dachsberger@…>

In bbdf938/rtems:

doxygen: Added RTEMS Test Framework to API

Update #3706.

comment:65 Changed on Apr 4, 2019 at 6:29:16 AM by Andreas Dachsberger <andreas.dachsberger@…>

In c9bd696/rtems:

doxygen: New API subgroup Tracing

Update #3706.

comment:66 Changed on Apr 4, 2019 at 6:29:20 AM by Andreas Dachsberger <andreas.dachsberger@…>

In 7b09032/rtems:

doxygen: Split up "libmisc" subgroups and removed libmisc

Update #3706.

comment:67 Changed on Apr 4, 2019 at 7:19:12 AM by Sebastian Huber <sebastian.huber@…>

In 4c20da4/rtems:

doxygen: Rename Score* groups in RTEMSScore*

Update #3706

Note: See TracTickets for help on using tickets.