aboutsummaryrefslogtreecommitdiffstats
path: root/test/test.dox
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-08-30 08:49:10 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-08-30 08:49:10 +0000
commit49c40ba106e8fbea8e67157591eab7bf0c9e9a01 (patch)
treedfd145ca9a7d70960de75169b124a4b2d8b99193 /test/test.dox
parent576d80eb6337c518374ed4ff4c54ff544708a98a (diff)
downloadChibiOS-49c40ba106e8fbea8e67157591eab7bf0c9e9a01.tar.gz
ChibiOS-49c40ba106e8fbea8e67157591eab7bf0c9e9a01.tar.bz2
ChibiOS-49c40ba106e8fbea8e67157591eab7bf0c9e9a01.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1136 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'test/test.dox')
-rw-r--r--test/test.dox47
1 files changed, 47 insertions, 0 deletions
diff --git a/test/test.dox b/test/test.dox
new file mode 100644
index 000000000..ad3c03927
--- /dev/null
+++ b/test/test.dox
@@ -0,0 +1,47 @@
+/*
+ ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio.
+
+ This file is part of ChibiOS/RT.
+
+ ChibiOS/RT is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ ChibiOS/RT is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @page testsuite Test Suite
+ * <h2>Description</h2>
+ * Most of the ChibiOS/RT demos link a set of software modules (test suite) in
+ * order to verify the proper working of the kernel, the port and the demo
+ * itself.<br>
+ * Each Test Module performs a series of tests on a specified subsystem or
+ * subsystems and can report a failure/success status and/or a performance
+ * index as the test suite output.<br>
+ * The test suite is usually activated in the demo applications by pressing a
+ * button on the target board, see the readme into the various demos
+ * directories. The test suite output is usually sent through a serial port and
+ * can be examined by using a terminal emulator program.
+ *
+ * <h2>Test Modules</h2>
+ * - @subpage test_threads
+ * - @subpage test_dynamic
+ * - @subpage test_msg
+ * - @subpage test_sem
+ * - @subpage test_mtx
+ * - @subpage test_events
+ * - @subpage test_mbox
+ * - @subpage test_queues
+ * - @subpage test_heap
+ * - @subpage test_pools
+ * - @subpage test_benchmarks
+ * .
+ */