doxygen: Add groups for related test suites

2025-12-05 15:15:44 +00:00 · 2023-03-13 13:49:18 +01:00
parent 377eae4165
commit 9bb2f59efe
49 changed files with 75 additions and 51 deletions
--- a/cpukit/doxygen/top-level-groups.h
+++ b/cpukit/doxygen/top-level-groups.h
@@ -63,3 +63,27 @@
 *
 * @brief This group contains the test suites.
 */
+
+/**
+ * @defgroup RTEMSTestSuitesFilesystem Filesystem Test Suites
+ *
+ * @ingroup RTEMSTestSuites
+ *
+ * @brief This group contains the test suites related to filesystem tests.
+ */
+
+/**
+ * @defgroup RTEMSTestSuitesUnit Unit Test Suites
+ *
+ * @ingroup RTEMSTestSuites
+ *
+ * @brief This group contains the test suites related to unit tests.
+ */
+
+/**
+ * @defgroup RTEMSTestSuitesValidation Validation Test Suites
+ *
+ * @ingroup RTEMSTestSuites
+ *
+ * @brief This group contains the test suites related to validation tests.
+ */
--- a/testsuites/fstests/tftpfs/tftpfs_udp_network_fake.h
+++ b/testsuites/fstests/tftpfs/tftpfs_udp_network_fake.h
@@ -52,7 +52,7 @@ extern "C" {
 /**
 * @defgroup RTEMSTestSuiteTestsTFTPFS Test suite for libtftpsfs tests
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesFilesystem
 *
 * @brief This test suite provides a tests for libtftpfs.
 *
--- a/testsuites/unit/ts-unit-no-clock-0.c
+++ b/testsuites/unit/ts-unit-no-clock-0.c
@@ -57,7 +57,7 @@
 /**
 * @defgroup TestsuitesUnitNoClock0 spec:/testsuites/unit-no-clock-0
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesUnit
 *
 * @brief This general purpose unit test suite provides enough resources to run
 *   basic tests without a Clock Driver for all specified managers and
--- a/testsuites/validation/ts-config.h
+++ b/testsuites/validation/ts-config.h
@@ -3,7 +3,7 @@
 /**
 * @file
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValdation
 *
 * @brief This header file provides the constants used by the test suite
 *   configuration.
@@ -44,7 +44,7 @@ extern "C" {
 #endif

 /**
- * @addtogroup RTEMSTestSuites
+ * @addtogroup RTEMSTestSuitesValdation
 *
 * @{
 */
--- a/testsuites/validation/ts-fatal-boot-processor-not-assigned-to-scheduler.c
+++ b/testsuites/validation/ts-fatal-boot-processor-not-assigned-to-scheduler.c
@@ -61,7 +61,7 @@
 * @defgroup TestsuitesFatalBootProcessorNotAssignedToScheduler \
 *   spec:/testsuites/fatal-boot-processor-not-assigned-to-scheduler
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite uses an application configuration which
 *   triggers a fatal error during system initialization.
--- a/testsuites/validation/ts-fatal-idle-thread-create-failed.c
+++ b/testsuites/validation/ts-fatal-idle-thread-create-failed.c
@@ -60,7 +60,7 @@
 * @defgroup TestsuitesFatalIdleThreadCreateFailed \
 *   spec:/testsuites/fatal-idle-thread-create-failed
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite contains a test case which is triggered by
 *   a fatal error during system initialization.
--- a/testsuites/validation/ts-fatal-idle-thread-stack-too-small.c
+++ b/testsuites/validation/ts-fatal-idle-thread-stack-too-small.c
@@ -60,7 +60,7 @@
 * @defgroup TestsuitesFatalIdleThreadStackTooSmall \
 *   spec:/testsuites/fatal-idle-thread-stack-too-small
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite contains a test case which triggers a
 *   fatal error during system initialization.
--- a/testsuites/validation/ts-fatal-init-task-construct-failed.c
+++ b/testsuites/validation/ts-fatal-init-task-construct-failed.c
@@ -60,7 +60,7 @@
 * @defgroup TestsuitesFatalInitTaskConstructFailed \
 *   spec:/testsuites/fatal-init-task-construct-failed
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite contains a test case which triggers a
 *   fatal error during system initialization.
--- a/testsuites/validation/ts-fatal-mandatory-processor-not-present.c
+++ b/testsuites/validation/ts-fatal-mandatory-processor-not-present.c
@@ -61,7 +61,7 @@
 * @defgroup TestsuitesFatalMandatoryProcessorNotPresent \
 *   spec:/testsuites/fatal-mandatory-processor-not-present
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite contains a test case which triggers a
 *   fatal error during system initialization.
--- a/testsuites/validation/ts-fatal-scheduler-requires-exactly-one-processor.c
+++ b/testsuites/validation/ts-fatal-scheduler-requires-exactly-one-processor.c
@@ -61,7 +61,7 @@
 * @defgroup TestsuitesFatalSchedulerRequiresExactlyOneProcessor \
 *   spec:/testsuites/fatal-scheduler-requires-exactly-one-processor
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite uses an application configuration which
 *   triggers a fatal error during system initialization.
--- a/testsuites/validation/ts-fatal-smp.c
+++ b/testsuites/validation/ts-fatal-smp.c
@@ -60,7 +60,7 @@
 /**
 * @defgroup TestsuitesFatalSmp spec:/testsuites/fatal-smp
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite contains a test case which triggers
 *   SMP-specific fatal errors.
--- a/testsuites/validation/ts-fatal-start-of-mandatory-processor-failed.c
+++ b/testsuites/validation/ts-fatal-start-of-mandatory-processor-failed.c
@@ -61,7 +61,7 @@
 * @defgroup TestsuitesFatalStartOfMandatoryProcessorFailed \
 *   spec:/testsuites/fatal-start-of-mandatory-processor-failed
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite contains a test case which triggers a
 *   fatal error during system initialization.
--- a/testsuites/validation/ts-fatal-start-on-not-online-processor.c
+++ b/testsuites/validation/ts-fatal-start-on-not-online-processor.c
@@ -61,7 +61,7 @@
 * @defgroup TestsuitesFatalStartOnNotOnlineProcessor \
 *   spec:/testsuites/fatal-start-on-not-online-processor
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite contains a test case which triggers a
 *   fatal error during system initialization.
--- a/testsuites/validation/ts-fatal-too-large-tls-size.c
+++ b/testsuites/validation/ts-fatal-too-large-tls-size.c
@@ -60,7 +60,7 @@
 * @defgroup TestsuitesFatalTooLargeTlsSize \
 *   spec:/testsuites/fatal-too-large-tls-size
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite contains a test case which triggers a
 *   fatal error during system initialization.
--- a/testsuites/validation/ts-performance-no-clock-0.c
+++ b/testsuites/validation/ts-performance-no-clock-0.c
@@ -60,7 +60,7 @@
 * @defgroup TestsuitesPerformanceNoClock0 \
 *   spec:/testsuites/performance-no-clock-0
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This general purpose performance test suite provides enough resources
 *   to run basic performance tests for all specified managers and functions.
--- a/testsuites/validation/ts-terminate.c
+++ b/testsuites/validation/ts-terminate.c
@@ -59,7 +59,7 @@
 /**
 * @defgroup TestsuitesTerminate spec:/testsuites/terminate
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite contains a test case for the system
 *   termination procedure.
--- a/testsuites/validation/ts-userext.c
+++ b/testsuites/validation/ts-userext.c
@@ -59,7 +59,7 @@
 /**
 * @defgroup TestsuitesUserext spec:/testsuites/userext
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite contains a test cases related to the
 *   invocation of user extensions.
--- a/testsuites/validation/ts-validation-0.c
+++ b/testsuites/validation/ts-validation-0.c
@@ -57,7 +57,7 @@
 /**
 * @defgroup TestsuitesValidation0 spec:/testsuites/validation-0
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This general purpose validation test suite provides enough resources
 *   to run basic tests for all specified managers and functions.
--- a/testsuites/validation/ts-validation-1.c
+++ b/testsuites/validation/ts-validation-1.c
@@ -57,7 +57,7 @@
 /**
 * @defgroup TestsuitesValidation1 spec:/testsuites/validation-1
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This general purpose validation test suite provides enough resources
 *   to run basic tests for all specified managers and functions.
--- a/testsuites/validation/ts-validation-acfg-0.c
+++ b/testsuites/validation/ts-validation-acfg-0.c
@@ -60,7 +60,7 @@
 /**
 * @defgroup TestsuitesValidationAcfg0 spec:/testsuites/validation-acfg-0
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite is used to validate the default value of
 *   application configuration options taking the optional BSP provided
--- a/testsuites/validation/ts-validation-acfg-1.c
+++ b/testsuites/validation/ts-validation-acfg-1.c
@@ -61,7 +61,7 @@
 /**
 * @defgroup TestsuitesValidationAcfg1 spec:/testsuites/validation-acfg-1
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite is used to validate the default value of
 *   application configuration options where all optional BSP provided settings
--- a/testsuites/validation/ts-validation-cache.c
+++ b/testsuites/validation/ts-validation-cache.c
@@ -57,7 +57,7 @@
 /**
 * @defgroup TestsuitesValidationCache spec:/testsuites/validation-cache
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite provides enough resources to run tests for
 *   the directives of the @ref RTEMSAPIClassicCache.
--- a/testsuites/validation/ts-validation-intr.c
+++ b/testsuites/validation/ts-validation-intr.c
@@ -57,7 +57,7 @@
 /**
 * @defgroup TestsuitesValidationIntr spec:/testsuites/validation-intr
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite provides enough resources to run tests for
 *   the interrupt controller related directives of the @ref
--- a/testsuites/validation/ts-validation-io-kernel.c
+++ b/testsuites/validation/ts-validation-io-kernel.c
@@ -64,7 +64,7 @@
 /**
 * @defgroup TestsuitesValidationIoKernel spec:/testsuites/validation-io-kernel
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite contains test cases which test the kernel
 *   character input/output device provided by the BSP before the system
--- a/testsuites/validation/ts-validation-no-clock-0.c
+++ b/testsuites/validation/ts-validation-no-clock-0.c
@@ -58,7 +58,7 @@
 * @defgroup TestsuitesValidationNoClock0 \
 *   spec:/testsuites/validation-no-clock-0
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This general purpose validation test suite provides enough resources
 *   to run basic tests without a Clock Driver for all specified managers and
--- a/testsuites/validation/ts-validation-non-smp.c
+++ b/testsuites/validation/ts-validation-non-smp.c
@@ -57,7 +57,7 @@
 /**
 * @defgroup TestsuitesValidationNonSmp spec:/testsuites/validation-non-smp
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This test suite for non-SMP test cases provides enough resources to
 *   run basic tests for all specified managers and functions.
--- a/testsuites/validation/ts-validation-one-cpu-0.c
+++ b/testsuites/validation/ts-validation-one-cpu-0.c
@@ -57,7 +57,7 @@
 /**
 * @defgroup TestsuitesValidationOneCpu0 spec:/testsuites/validation-one-cpu-0
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This general purpose validation test suite provides enough resources
 *   to run basic tests with exactly one processor and without a Clock Driver.
--- a/testsuites/validation/ts-validation-one-cpu-1.c
+++ b/testsuites/validation/ts-validation-one-cpu-1.c
@@ -59,7 +59,7 @@
 /**
 * @defgroup TestsuitesValidationOneCpu1 spec:/testsuites/validation-one-cpu-1
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This general purpose validation test suite provides enough resources
 *   to run basic tests with exactly one processor and without a Clock Driver.
--- a/testsuites/validation/ts-validation-smp-one-cpu-0.c
+++ b/testsuites/validation/ts-validation-smp-one-cpu-0.c
@@ -58,7 +58,7 @@
 * @defgroup TestsuitesValidationSmpOneCpu0 \
 *   spec:/testsuites/validation-smp-one-cpu-0
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This general purpose validation test suite provides enough resources
 *   to run basic tests for all specified managers and functions in a
--- a/testsuites/validation/ts-validation-smp-only-0.c
+++ b/testsuites/validation/ts-validation-smp-only-0.c
@@ -58,7 +58,7 @@
 * @defgroup TestsuitesValidationSmpOnly0 \
 *   spec:/testsuites/validation-smp-only-0
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This test suite for SMP-only test cases provides enough resources to
 *   run basic tests for all specified managers and functions.
--- a/testsuites/validation/ts-validation-smp-only-2.c
+++ b/testsuites/validation/ts-validation-smp-only-2.c
@@ -60,7 +60,7 @@
 * @defgroup TestsuitesValidationSmpOnly2 \
 *   spec:/testsuites/validation-smp-only-2
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This SMP-only test suite validates the clustered scheduler
 *   configuration through an application configuration with a processor
--- a/testsuites/validation/ts-validation-timecounter-0.c
+++ b/testsuites/validation/ts-validation-timecounter-0.c
@@ -58,7 +58,7 @@
 * @defgroup TestsuitesValidationTimecounter0 \
 *   spec:/testsuites/validation-timecounter-0
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite is intended test cases related to the
 *   installation of timecouters.  The Clock Driver is disabled.
--- a/testsuites/validation/ts-validation-timecounter-1.c
+++ b/testsuites/validation/ts-validation-timecounter-1.c
@@ -58,7 +58,7 @@
 * @defgroup TestsuitesValidationTimecounter1 \
 *   spec:/testsuites/validation-timecounter-1
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite is intended test cases related to the use
 *   of timecouters.  The Clock Driver is enabled.
--- a/testsuites/validation/ts-validation-timecounter-smp-0.c
+++ b/testsuites/validation/ts-validation-timecounter-smp-0.c
@@ -58,7 +58,7 @@
 * @defgroup TestsuitesValidationTimecounterSmp0 \
 *   spec:/testsuites/validation-timecounter-smp-0
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite is intended test cases related to the use
 *   of timecouters.  The Clock Driver is disabled.
--- a/testsuites/validation/ts-validation-tls-0.c
+++ b/testsuites/validation/ts-validation-tls-0.c
@@ -57,7 +57,7 @@
 /**
 * @defgroup TestsuitesValidationTls0 spec:/testsuites/validation-tls-0
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite contains test cases related to the
 *   thread-local storage support.
--- a/testsuites/validation/ts-validation-tls-1.c
+++ b/testsuites/validation/ts-validation-tls-1.c
@@ -57,7 +57,7 @@
 /**
 * @defgroup TestsuitesValidationTls1 spec:/testsuites/validation-tls-1
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValidation
 *
 * @brief This validation test suite contains test cases related to the
 *   thread-local storage support.
--- a/testsuites/validation/tx-call-within-isr.c
+++ b/testsuites/validation/tx-call-within-isr.c
@@ -3,7 +3,7 @@
 /**
 * @file
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValdation
 *
 * @brief This source file contains the implementation of CallWithinISRClear(),
 *   CallWithinISRGetVector(), CallWithinISR(), CallWithinISRRaise(),
--- a/testsuites/validation/tx-default-task-config.c
+++ b/testsuites/validation/tx-default-task-config.c
@@ -3,7 +3,7 @@
 /**
 * @file
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValdation
 *
 * @brief This source file contains the definition of ::DefaultTaskConfig.
 */
--- a/testsuites/validation/tx-interrupt.c
+++ b/testsuites/validation/tx-interrupt.c
@@ -3,7 +3,7 @@
 /**
 * @file
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValdation
 *
 * @brief This source file contains the implementation of
 *   HasInterruptVectorEntriesInstalled().
--- a/testsuites/validation/tx-io-relax.c
+++ b/testsuites/validation/tx-io-relax.c
@@ -3,7 +3,7 @@
 /**
 * @file
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValdation
 *
 * @brief This source file contains the implementation of SetIORelaxHandler().
 */
--- a/testsuites/validation/tx-memory-alloc.c
+++ b/testsuites/validation/tx-memory-alloc.c
@@ -3,7 +3,7 @@
 /**
 * @file
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValdation
 *
 * @brief This source file contains the implementation of
 *   MemoryAllocationFailWhen() and __wrap_rtems_malloc().
--- a/testsuites/validation/tx-preemption-intervention.c
+++ b/testsuites/validation/tx-preemption-intervention.c
@@ -3,7 +3,7 @@
 /**
 * @file
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValdation
 *
 * @brief This source file contains the implementation of
 *   SetPreemptionIntervention().
--- a/testsuites/validation/tx-support.c
+++ b/testsuites/validation/tx-support.c
@@ -3,7 +3,7 @@
 /**
 * @file
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValdation
 *
 * @brief This source file contains the implementation of support functions for
 *   the validation test cases.
--- a/testsuites/validation/tx-support.h
+++ b/testsuites/validation/tx-support.h
@@ -3,7 +3,7 @@
 /**
 * @file
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValdation
 *
 * @brief This header file provides the support functions for the validation
 *   test cases.
@@ -47,7 +47,7 @@ extern "C" {
 #endif

 /**
- * @addtogroup RTEMSTestSuites
+ * @addtogroup RTEMSTestSuitesValdation
 *
 * @{
 */
--- a/testsuites/validation/tx-thread-queue.c
+++ b/testsuites/validation/tx-thread-queue.c
@@ -3,7 +3,7 @@
 /**
 * @file
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValdation
 *
 * @brief This source file contains the implementation of the thread queue test
 *   support.
--- a/testsuites/validation/tx-thread-queue.h
+++ b/testsuites/validation/tx-thread-queue.h
@@ -3,7 +3,7 @@
 /**
 * @file
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValdation
 *
 * @brief This header file provides the functions to test the
 *   @ref RTEMSScoreThreadQueue.
@@ -50,7 +50,7 @@ extern "C" {
 #endif

 /**
- * @addtogroup RTEMSTestSuites
+ * @addtogroup RTEMSTestSuitesValdation
 *
 * @{
 */
--- a/testsuites/validation/tx-timecounter.c
+++ b/testsuites/validation/tx-timecounter.c
@@ -3,7 +3,7 @@
 /**
 * @file
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValdation
 *
 * @brief This source file contains the definition of SetGetTimecountHandler(),
 *   GetTimecountCounter(), and SetTimecountCounter().
--- a/testsuites/validation/tx-timer-server.c
+++ b/testsuites/validation/tx-timer-server.c
@@ -3,7 +3,7 @@
 /**
 * @file
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValdation
 *
 * @brief This source file contains the definition of DeleteTimerServer().
 */
--- a/testsuites/validation/tx-wrap-thread-queue.c
+++ b/testsuites/validation/tx-wrap-thread-queue.c
@@ -3,7 +3,7 @@
 /**
 * @file
 *
- * @ingroup RTEMSTestSuites
+ * @ingroup RTEMSTestSuitesValdation
 *
 * @brief This source file contains the implementation of the thread queue
 *   wrapper.