[PATCH 1/1] testsuite: A description for each test added

Moyano, Gabriel gabriel.moyano at dlr.de
Tue Mar 31 12:14:20 UTC 2020 

---
 testsuite/arphole/test_main.c            | 14 +++++++-------
 testsuite/cdev01/test_main.c             |  7 +++++++
 testsuite/commands01/test_main.c         |  6 ++++++
 testsuite/condvar01/test_main.c          |  7 +++++++
 testsuite/crypto01/test_main.c           |  6 ++++++
 testsuite/debugger01/test_main.c         |  6 ++++++
 testsuite/dhcpcd01/test_main.c           |  7 +++++++
 testsuite/dhcpcd02/test_main.c           |  6 ++++++
 testsuite/epoch01/test_main.c            |  8 ++++++++
 testsuite/evdev01/init.c                 |  6 ++++++
 testsuite/foobarclient/test_main.c       |  9 +++++++++
 testsuite/foobarserver/test_main.c       | 11 +++++++++++
 testsuite/ftpd01/test_main.c             |  6 ++++++
 testsuite/ftpd02/test_main.c             |  6 ++++++
 testsuite/init01/test_main.c             |  4 +++-
 testsuite/ipsec01/test_main.c            |  7 +++++++
 testsuite/lagg01/test_main.c             |  6 ++++++
 testsuite/log01/test_main.c              |  6 ++++++
 testsuite/loopback01/test_main.c         |  8 +++++---
 testsuite/media01/test_main.c            |  7 +++++++
 testsuite/mutex01/test_main.c            |  6 ++++++
 testsuite/netshell01/test_main.c         |  7 ++++---
 testsuite/nfs01/test_main.c              |  6 ++++++
 testsuite/openssl01/test_main.c          |  6 ++++++
 testsuite/openssl02/test_main.c          |  7 +++++++
 testsuite/pf01/test_main.c               |  6 ++++++
 testsuite/pf02/test_main.c               |  7 +++++++
 testsuite/ping01/test_main.c             |  6 ++++++
 testsuite/ppp01/test_main.c              |  4 +++-
 testsuite/program01/test_main.c          |  6 ++++++
 testsuite/rcconf01/test_main.c           |  8 ++++++++
 testsuite/rcconf02/test_main.c           |  6 +++++-
 testsuite/rwlock01/test_main.c           |  6 ++++++
 testsuite/selectpollkqueue01/test_main.c |  6 ++++++
 testsuite/sleep01/test_main.c            | 10 ++++++++++
 testsuite/smp01/test_main.c              |  7 +++++++
 testsuite/swi01/init.c                   |  7 +++++++
 testsuite/syscalls01/test_main.c         |  6 ++++++
 testsuite/telnetd01/test_main.c          |  6 ++++++
 testsuite/termios/test_main.c            |  6 ++++++
 testsuite/termios01/test_main.c          |  7 +++++++
 testsuite/termios02/test_main.c          |  9 ++++++++-
 testsuite/termios03/test_main.c          |  8 +++++++-
 testsuite/termios04/test_main.c          |  8 +++++++-
 testsuite/termios05/test_main.c          |  8 +++++++-
 testsuite/termios06/test_main.c          |  7 +++++++
 testsuite/thread01/test_main.c           |  8 ++++++++
 testsuite/timeout01/init.c               |  6 ++++++
 testsuite/unix01/test_main.c             |  6 ++++++
 testsuite/usb01/init.c                   |  7 +++++++
 testsuite/usbkbd01/init.c                |  6 ++++++
 testsuite/usbmouse01/init.c              |  5 ++++-
 testsuite/usbserial01/init.c             |  6 ++++++
 testsuite/vlan01/test_main.c             |  6 ++++++
 testsuite/zerocopy01/test_main.c         |  6 ++++++
 55 files changed, 354 insertions(+), 21 deletions(-)

diff --git a/testsuite/arphole/test_main.c b/testsuite/arphole/test_main.c
index 45a28cc0..de4bc16c 100644
--- a/testsuite/arphole/test_main.c
+++ b/testsuite/arphole/test_main.c
@@ -1,10 +1,3 @@
-/**
- * @file
- *
- * This test program processes all ARP requests and claims every IP address it
- * notices.  Use with care in production networks.
- */
-
 /*
  * Copyright (c) 2014 embedded brains GmbH.  All rights reserved.
  *
@@ -36,6 +29,13 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * This test program processes all ARP requests and claims every IP address it
+ * notices.  Use with care in production networks.
+ */
+
 #include <sys/types.h>
 
 #include <net/if.h>
diff --git a/testsuite/cdev01/test_main.c b/testsuite/cdev01/test_main.c
index cbff9133..1ff8385a 100644
--- a/testsuite/cdev01/test_main.c
+++ b/testsuite/cdev01/test_main.c
@@ -29,6 +29,13 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * It creates a character device (cdev) and tests the basic i/o functions,
+ * e.g. open(), read(), write(), ioctl(), etc.
+ */
+
 #include <sys/types.h>
 #include <sys/event.h>
 #include <sys/stat.h>
diff --git a/testsuite/commands01/test_main.c b/testsuite/commands01/test_main.c
index 73168eac..50b4ed76 100644
--- a/testsuite/commands01/test_main.c
+++ b/testsuite/commands01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ * The following commands are tested: route, ifconfig, ping, ping6 (if defined),
+ * netstat and wlanstats (if defined).
+ */
+
 #include <sys/param.h>
 
 #include <assert.h>
diff --git a/testsuite/condvar01/test_main.c b/testsuite/condvar01/test_main.c
index 8b2d102b..86dd5101 100644
--- a/testsuite/condvar01/test_main.c
+++ b/testsuite/condvar01/test_main.c
@@ -29,6 +29,13 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * It tests condition variable (condvar) sending RTEMS events to two
+ * workers (RTEMS tasks).
+ */
+
 #include <machine/rtems-bsd-kernel-space.h>
 
 #include <sys/param.h>
diff --git a/testsuite/crypto01/test_main.c b/testsuite/crypto01/test_main.c
index 5c6b725e..9e949704 100644
--- a/testsuite/crypto01/test_main.c
+++ b/testsuite/crypto01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * It tests /dev/crypto device.
+ */
+
 #include <sys/cdefs.h>
 #include <sys/ioctl.h>
 #include <sys/time.h>
diff --git a/testsuite/debugger01/test_main.c b/testsuite/debugger01/test_main.c
index 777e8a76..170a346a 100644
--- a/testsuite/debugger01/test_main.c
+++ b/testsuite/debugger01/test_main.c
@@ -24,6 +24,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * It tests RTEMS debugger (TCP:1122).
+ */
+
 #include <assert.h>
 #include <errno.h>
 #include <string.h>
diff --git a/testsuite/dhcpcd01/test_main.c b/testsuite/dhcpcd01/test_main.c
index 358b4ac8..b5929030 100644
--- a/testsuite/dhcpcd01/test_main.c
+++ b/testsuite/dhcpcd01/test_main.c
@@ -29,6 +29,13 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * It tests to add a hook to DHCP client daemon (dhcpcd).
+ * Every time the hook is called, the environment is printed out.
+ */
+
 #include <assert.h>
 #include <stdio.h>
 
diff --git a/testsuite/dhcpcd02/test_main.c b/testsuite/dhcpcd02/test_main.c
index 611c12b1..cfe1e778 100644
--- a/testsuite/dhcpcd02/test_main.c
+++ b/testsuite/dhcpcd02/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * It tests the DHCP client daemon (dhcpcd).
+ */
+
 #include <assert.h>
 
 #include <rtems.h>
diff --git a/testsuite/epoch01/test_main.c b/testsuite/epoch01/test_main.c
index dd8aa50f..2205e09d 100644
--- a/testsuite/epoch01/test_main.c
+++ b/testsuite/epoch01/test_main.c
@@ -29,6 +29,14 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * The following epoch functions are tested with parallel tasks: epoch_enter(),
+ * epoch_exit(), epoch_call(), epoch_wait(), epoch_enter_preempt(),
+ * epoch_exit_preempt(), epoch_wait_preempt() and epoch_drain_callbacks().
+ */
+
 #include <machine/rtems-bsd-kernel-space.h>
 
 #include <sys/param.h>
diff --git a/testsuite/evdev01/init.c b/testsuite/evdev01/init.c
index af375ee4..bf2ed222 100644
--- a/testsuite/evdev01/init.c
+++ b/testsuite/evdev01/init.c
@@ -24,6 +24,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * Different event devices (evdev) are tested in different RTEMS tasks.
+ */
+
 #include <sys/malloc.h>
 #include <assert.h>
 #include <stdio.h>
diff --git a/testsuite/foobarclient/test_main.c b/testsuite/foobarclient/test_main.c
index 85007ee8..f6e7e84c 100644
--- a/testsuite/foobarclient/test_main.c
+++ b/testsuite/foobarclient/test_main.c
@@ -29,6 +29,15 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * The multicast DNS (mDNS) protocol is tested.
+ * To run this test is also required to run foobarserver.
+ * The following functions are called: mDNS_StartBrowse(),
+ * mDNS_StartResolveService() and mDNS_StopResolveService().
+ */
+
 #include <sys/select.h>
 #include <sys/socket.h>
 
diff --git a/testsuite/foobarserver/test_main.c b/testsuite/foobarserver/test_main.c
index a239a561..f03be437 100644
--- a/testsuite/foobarserver/test_main.c
+++ b/testsuite/foobarserver/test_main.c
@@ -29,6 +29,17 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * The multicast DNS (mDNS) protocol is tested.
+ * To run this test is also required to run foobarclient.
+ * A TCP socket (SOCK_STREAM) is open from port FOOBAR_PORT_BEGIN to
+ * port FOOBAR_PORT_END - 1 on at a time.
+ * The following functions are called: mDNS_RegisterService(),
+ * mDNS_DeregisterService() and mDNS_RenameAndReregisterService().
+ */
+
 #include <mDNSEmbeddedAPI.h>
 #include <mDNSPosix.h>
 
diff --git a/testsuite/ftpd01/test_main.c b/testsuite/ftpd01/test_main.c
index 98eb47ef..0a838f48 100644
--- a/testsuite/ftpd01/test_main.c
+++ b/testsuite/ftpd01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * It starts an FTP daemon (ftpd).
+ */
+
 #include <assert.h>
 
 #include <rtems.h>
diff --git a/testsuite/ftpd02/test_main.c b/testsuite/ftpd02/test_main.c
index 3eb079d2..02645b22 100644
--- a/testsuite/ftpd02/test_main.c
+++ b/testsuite/ftpd02/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * File handling basics are tested in an FTP file system locally.
+ */
+
 #include <sys/stat.h>
 #include <fcntl.h>
 #include <assert.h>
diff --git a/testsuite/init01/test_main.c b/testsuite/init01/test_main.c
index 61d7836b..ea45b511 100644
--- a/testsuite/init01/test_main.c
+++ b/testsuite/init01/test_main.c
@@ -1,4 +1,6 @@
-/*
+/**
+ * @file
+ *
  *  This is the body of the test. It does not do much except ensure
  *  that the target is alive after initializing the TCP/IP stack.
  */
diff --git a/testsuite/ipsec01/test_main.c b/testsuite/ipsec01/test_main.c
index 651a4056..b0c21505 100644
--- a/testsuite/ipsec01/test_main.c
+++ b/testsuite/ipsec01/test_main.c
@@ -29,6 +29,13 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * It tests Internet Protocol Security protocol (ipsec).
+ * It needs a communication partner (see testsuit/ipsec01/README).
+ */
+
 #define TEST_NAME "LIBBSD IPSEC 1"
 #define TEST_STATE_USER_INPUT 1
 
diff --git a/testsuite/lagg01/test_main.c b/testsuite/lagg01/test_main.c
index 99544a52..5ec49722 100644
--- a/testsuite/lagg01/test_main.c
+++ b/testsuite/lagg01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * A link aggregation (lagg) is tested (ifconfig command is used to do this).
+ */
+
 #include <sys/stat.h>
 #include <net/if.h>
 
diff --git a/testsuite/log01/test_main.c b/testsuite/log01/test_main.c
index 45f62cdf..e1be64d2 100644
--- a/testsuite/log01/test_main.c
+++ b/testsuite/log01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * Different logging levels are tested.
+ */
+
 #include <machine/rtems-bsd-kernel-space.h>
 
 #include <sys/types.h>
diff --git a/testsuite/loopback01/test_main.c b/testsuite/loopback01/test_main.c
index f0453e69..609935e9 100644
--- a/testsuite/loopback01/test_main.c
+++ b/testsuite/loopback01/test_main.c
@@ -1,6 +1,8 @@
-/*
- *  This is the body of the test. It does not do much except ensure
- *  that the target is alive after initializing the TCP/IP stack.
+/**
+ * @file
+ *
+ * It tests socket connections locally. The server and clients are running in
+ * different RTEMS tasks.
  */
 
 #include <stdlib.h>
diff --git a/testsuite/media01/test_main.c b/testsuite/media01/test_main.c
index 942664cd..15a4de5e 100644
--- a/testsuite/media01/test_main.c
+++ b/testsuite/media01/test_main.c
@@ -29,6 +29,13 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * Code used to test the Media Manager. Telnet daemon (telnetd) and
+ * FTP daemon (ftpd) are started. Events are recorded.
+ */
+
 #include <sys/param.h>
 
 #include <assert.h>
diff --git a/testsuite/mutex01/test_main.c b/testsuite/mutex01/test_main.c
index c3e193d9..6bc67343 100644
--- a/testsuite/mutex01/test_main.c
+++ b/testsuite/mutex01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * Different mutex methods are tested.
+ */
+
 #include <machine/rtems-bsd-kernel-space.h>
 
 #include <sys/param.h>
diff --git a/testsuite/netshell01/test_main.c b/testsuite/netshell01/test_main.c
index 13d8a31c..b54b9236 100644
--- a/testsuite/netshell01/test_main.c
+++ b/testsuite/netshell01/test_main.c
@@ -24,9 +24,10 @@
  * SUCH DAMAGE.
  */
 
-/*
- *  This is the body of the test. It does not do much except ensure
- *  that the target is alive after initializing the TCP/IP stack.
+/**
+ * @file
+ *
+ * RTEMS shell is started and it is possible to run net commands.
  */
 
 #include <assert.h>
diff --git a/testsuite/nfs01/test_main.c b/testsuite/nfs01/test_main.c
index d50edc37..915c8bb8 100644
--- a/testsuite/nfs01/test_main.c
+++ b/testsuite/nfs01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * It mounts a network file system (nfs).
+ */
+
 #include <assert.h>
 #include <unistd.h>
 
diff --git a/testsuite/openssl01/test_main.c b/testsuite/openssl01/test_main.c
index 4359b5f0..bc51cb00 100644
--- a/testsuite/openssl01/test_main.c
+++ b/testsuite/openssl01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * It tests encryption and decryption using openssl.
+ */
+
 #define TEST_NAME "LIBBSD OPENSSL 1"
 
 #include <assert.h>
diff --git a/testsuite/openssl02/test_main.c b/testsuite/openssl02/test_main.c
index 94a735b0..dc4c05c7 100644
--- a/testsuite/openssl02/test_main.c
+++ b/testsuite/openssl02/test_main.c
@@ -29,6 +29,13 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * The openssl certificate generation is tested and performance of
+ * cryptographic algorithm is shown.
+ */
+
 #include <sys/param.h>
 #include <sys/stat.h>
 #include <assert.h>
diff --git a/testsuite/pf01/test_main.c b/testsuite/pf01/test_main.c
index 9421f0e6..8b6577ec 100644
--- a/testsuite/pf01/test_main.c
+++ b/testsuite/pf01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * Packet filter rules are tested (see defines below).
+ */
+
 #include <assert.h>
 #include <fcntl.h>
 #include <stdio.h>
diff --git a/testsuite/pf02/test_main.c b/testsuite/pf02/test_main.c
index 3e71ebb4..db6bbe7e 100644
--- a/testsuite/pf02/test_main.c
+++ b/testsuite/pf02/test_main.c
@@ -29,6 +29,13 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * Packet filter rules are tested (see defines below). RTEMS shell starts
+ * at the end of the test.
+ */
+
 #include <assert.h>
 #include <fcntl.h>
 #include <stdlib.h>
diff --git a/testsuite/ping01/test_main.c b/testsuite/ping01/test_main.c
index 659043c4..19d1ba0f 100644
--- a/testsuite/ping01/test_main.c
+++ b/testsuite/ping01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * Ping (shell command) test.
+ */
+
 #include <assert.h>
 #include <errno.h>
 #include <stdio.h>
diff --git a/testsuite/ppp01/test_main.c b/testsuite/ppp01/test_main.c
index 550039e9..b6a06d61 100644
--- a/testsuite/ppp01/test_main.c
+++ b/testsuite/ppp01/test_main.c
@@ -29,7 +29,9 @@
  * SUCH DAMAGE.
  */
 
-/*
+/**
+ * @file
+ *
  * To test PPP connect the RTEMS target with your host.  Start PPP on the host
  * with something like this:
  *
diff --git a/testsuite/program01/test_main.c b/testsuite/program01/test_main.c
index 7691b210..05f7ab3f 100644
--- a/testsuite/program01/test_main.c
+++ b/testsuite/program01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * RTEMS function wrappers for BSD programs test.
+ */
+
 #include <err.h>
 #include <assert.h>
 #include <errno.h>
diff --git a/testsuite/rcconf01/test_main.c b/testsuite/rcconf01/test_main.c
index 4701390c..604afba3 100644
--- a/testsuite/rcconf01/test_main.c
+++ b/testsuite/rcconf01/test_main.c
@@ -23,6 +23,14 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * The following functions are tested: rtems_bsd_rc_conf_argc_argv_create(),
+ * rtems_bsd_rc_conf_find(), rtems_bsd_rc_conf_print_cmd() and
+ * rtems_bsd_rc_conf_find_next().
+ */
+
 #include <sys/param.h>
 
 #include <assert.h>
diff --git a/testsuite/rcconf02/test_main.c b/testsuite/rcconf02/test_main.c
index 3a7b7026..ae64296d 100644
--- a/testsuite/rcconf02/test_main.c
+++ b/testsuite/rcconf02/test_main.c
@@ -23,7 +23,11 @@
  * SUCH DAMAGE.
  */
 
-/*
+/**
+ * @file
+ *
+ * A rc.conf script (rc_conf_text) is run. RTEMS shell starts at the end of the test.
+ *
  * Tests:
  *
  * 1. rc.conf processing
diff --git a/testsuite/rwlock01/test_main.c b/testsuite/rwlock01/test_main.c
index a0ae91b6..ea073741 100644
--- a/testsuite/rwlock01/test_main.c
+++ b/testsuite/rwlock01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * Readers-writer lock is tested.
+ */
+
 #include <machine/rtems-bsd-kernel-space.h>
 
 #include <sys/param.h>
diff --git a/testsuite/selectpollkqueue01/test_main.c b/testsuite/selectpollkqueue01/test_main.c
index 244f5b50..74b3288d 100755
--- a/testsuite/selectpollkqueue01/test_main.c
+++ b/testsuite/selectpollkqueue01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * The following system calls are tested: select(), pselect(), poll(), kqueue() and pipe().
+ */
+
 #include <sys/param.h>
 #include <sys/types.h>
 #include <sys/event.h>
diff --git a/testsuite/sleep01/test_main.c b/testsuite/sleep01/test_main.c
index ffea7420..8826e1b9 100644
--- a/testsuite/sleep01/test_main.c
+++ b/testsuite/sleep01/test_main.c
@@ -29,6 +29,16 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * The following functions are tested: msleep(), msleep_spin(), tsleep(),
+ * wakeup() and wakeup_one().
+ * SLAVE_COUNT tasks are created. Each one increments its own counter and
+ * then it is sent to sleep with tsleep(). All tasks are grouped under the
+ * same channel. This means that all threads are woken up if wakeup() is called.
+ */
+
 #include <machine/rtems-bsd-kernel-space.h>
 
 #include <sys/param.h>
diff --git a/testsuite/smp01/test_main.c b/testsuite/smp01/test_main.c
index 583fe906..352b9f7d 100644
--- a/testsuite/smp01/test_main.c
+++ b/testsuite/smp01/test_main.c
@@ -29,6 +29,13 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * Symetric Multiprocessing (smp) is tested. Parallel jobs are run with
+ * rtems_test_parallel().
+ */
+
 #include <machine/rtems-bsd-kernel-space.h>
 
 #include <sys/param.h>
diff --git a/testsuite/swi01/init.c b/testsuite/swi01/init.c
index da5e4446..6a42c210 100644
--- a/testsuite/swi01/init.c
+++ b/testsuite/swi01/init.c
@@ -29,6 +29,13 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * Software interrupts (swi) are tested. The following functions are
+ * called: swi_add() and swi_sched().
+ */
+
 #include <stdlib.h>
 #include <stdio.h>
 #include <assert.h>
diff --git a/testsuite/syscalls01/test_main.c b/testsuite/syscalls01/test_main.c
index 58750561..7f1a48d0 100644
--- a/testsuite/syscalls01/test_main.c
+++ b/testsuite/syscalls01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * Different system calls are tested.
+ */
+
 #include <sys/cdefs.h>
 #include <sys/types.h>
 #include <sys/event.h>
diff --git a/testsuite/telnetd01/test_main.c b/testsuite/telnetd01/test_main.c
index 8fca493e..9de4e7e4 100644
--- a/testsuite/telnetd01/test_main.c
+++ b/testsuite/telnetd01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * The telnet daemon is run.
+ */
+
 #include <assert.h>
 #include <string.h>
 
diff --git a/testsuite/termios/test_main.c b/testsuite/termios/test_main.c
index 68a15c6f..c74b3d39 100644
--- a/testsuite/termios/test_main.c
+++ b/testsuite/termios/test_main.c
@@ -7,6 +7,12 @@
  *  http://www.rtems.org/license/LICENSE.
  */
 
+/**
+ * @file
+ *
+ * A program to test different setting of termios manually is run.
+ */
+
 #include <assert.h>
 #include <stdio.h>
 #include <stdlib.h>
diff --git a/testsuite/termios01/test_main.c b/testsuite/termios01/test_main.c
index e00ff865..964df1b8 100644
--- a/testsuite/termios01/test_main.c
+++ b/testsuite/termios01/test_main.c
@@ -7,6 +7,13 @@
  *  http://www.rtems.org/license/LICENSE.
  */
 
+/**
+ * @file
+ *
+ * Settings of termios (e.g. baudrate, parity, etc.) are tested.
+ * tcsetattr() is used to change the settings.
+ */
+
 #define TTYDEFCHARS
 #include <sys/ttydefaults.h>
 #include <assert.h>
diff --git a/testsuite/termios02/test_main.c b/testsuite/termios02/test_main.c
index 3ec5c0b2..12df132a 100644
--- a/testsuite/termios02/test_main.c
+++ b/testsuite/termios02/test_main.c
@@ -7,6 +7,13 @@
  *  http://www.rtems.org/license/LICENSE.
  */
 
+/**
+ * @file
+ *
+ * The following system calls are tested: tcflow(), tcflush(), tcgetpgrp(),
+ * tcsendbreak() and ctermid().
+ */
+
 #include <assert.h>
 #include <stdio.h>
 #include <stdlib.h>
@@ -137,4 +144,4 @@ test_main(void)
   exit(0);
 }
 
-#include <rtems/bsd/test/default-termios-init.h>
\ No newline at end of file
+#include <rtems/bsd/test/default-termios-init.h>
diff --git a/testsuite/termios03/test_main.c b/testsuite/termios03/test_main.c
index c92c4f0d..22f16480 100644
--- a/testsuite/termios03/test_main.c
+++ b/testsuite/termios03/test_main.c
@@ -7,6 +7,12 @@
  *  http://www.rtems.org/license/LICENSE.
  */
 
+/**
+ * @file
+ *
+ * read() and write() are tested using the termios utilities.
+ */
+
 #include <assert.h>
 #include <stdio.h>
 #include <stdlib.h>
@@ -70,4 +76,4 @@ test_main(void)
   exit(0);
 }
 
-#include <rtems/bsd/test/default-termios-init.h>
\ No newline at end of file
+#include <rtems/bsd/test/default-termios-init.h>
diff --git a/testsuite/termios04/test_main.c b/testsuite/termios04/test_main.c
index f4d94767..c8c74576 100644
--- a/testsuite/termios04/test_main.c
+++ b/testsuite/termios04/test_main.c
@@ -7,6 +7,12 @@
  *  http://www.rtems.org/license/LICENSE.
  */
 
+/**
+ * @file
+ *
+ * IXON and IXOFF flags test.
+ */
+
 #include <assert.h>
 #include <stdio.h>
 #include <stdlib.h>
@@ -66,4 +72,4 @@ test_main(void)
   exit(0);
 }
 
-#include <rtems/bsd/test/default-termios-init.h>
\ No newline at end of file
+#include <rtems/bsd/test/default-termios-init.h>
diff --git a/testsuite/termios05/test_main.c b/testsuite/termios05/test_main.c
index faad94fe..75d76212 100644
--- a/testsuite/termios05/test_main.c
+++ b/testsuite/termios05/test_main.c
@@ -7,6 +7,12 @@
  *  http://www.rtems.org/license/LICENSE.
  */
 
+/**
+ * @file
+ *
+ * Noncanonical mode test.
+ */
+
 #include <assert.h>
 #include <stdio.h>
 #include <stdlib.h>
@@ -62,4 +68,4 @@ test_main(void)
   exit(0);
 }
 
-#include <rtems/bsd/test/default-termios-init.h>
\ No newline at end of file
+#include <rtems/bsd/test/default-termios-init.h>
diff --git a/testsuite/termios06/test_main.c b/testsuite/termios06/test_main.c
index d70b7bdf..37e2a55a 100644
--- a/testsuite/termios06/test_main.c
+++ b/testsuite/termios06/test_main.c
@@ -7,6 +7,13 @@
  *  http://www.rtems.org/license/LICENSE.
  */
 
+/**
+ * @file
+ *
+ * The behavior of the following flags are tested: IGNCR, ISRTIP, IUCLC, ICRNL,
+ * INLCR, OPOST, ONLRET, ONLCR, ONOCR, OCRNL, OXTABS and OLCUC.
+ */
+
 #include <assert.h>
 #include <stdio.h>
 #include <stdlib.h>
diff --git a/testsuite/thread01/test_main.c b/testsuite/thread01/test_main.c
index fa15b9f6..43f6a95c 100644
--- a/testsuite/thread01/test_main.c
+++ b/testsuite/thread01/test_main.c
@@ -29,6 +29,14 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * The creation and execution of threads (RTEMS task, kproc, kthread) are tested.
+ * The main thread creates a worker and the waits until receives an event of the
+ * created worker.
+ */
+
 #include <machine/rtems-bsd-kernel-space.h>
 #include <machine/rtems-bsd-thread.h>
 
diff --git a/testsuite/timeout01/init.c b/testsuite/timeout01/init.c
index e2a24a82..49ac0ccf 100644
--- a/testsuite/timeout01/init.c
+++ b/testsuite/timeout01/init.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * The timeout and callout functions are tested.
+ */
+
 #include <stdlib.h>
 #include <stdio.h>
 #include <assert.h>
diff --git a/testsuite/unix01/test_main.c b/testsuite/unix01/test_main.c
index 61f9aa4e..12784398 100644
--- a/testsuite/unix01/test_main.c
+++ b/testsuite/unix01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * PF_UNIX sockets test.
+ */
+
 #include <sys/cdefs.h>
 #include <sys/param.h>
 #include <sys/un.h>
diff --git a/testsuite/usb01/init.c b/testsuite/usb01/init.c
index c719e193..9441670a 100644
--- a/testsuite/usb01/init.c
+++ b/testsuite/usb01/init.c
@@ -29,6 +29,13 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * Same as media01 but without ftpd and telnetd. RTEMS shell starts at the
+ * end of the test.
+ */
+
 #include <assert.h>
 #include <stdio.h>
 #include <stdlib.h>
diff --git a/testsuite/usbkbd01/init.c b/testsuite/usbkbd01/init.c
index e6fe2560..89dc6690 100644
--- a/testsuite/usbkbd01/init.c
+++ b/testsuite/usbkbd01/init.c
@@ -24,6 +24,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * USB keyboard test. RTEMS shell starts at the end of the test.
+ */
+
 #include <sys/malloc.h>
 #include <assert.h>
 #include <stdio.h>
diff --git a/testsuite/usbmouse01/init.c b/testsuite/usbmouse01/init.c
index 4d33241d..11f044f9 100644
--- a/testsuite/usbmouse01/init.c
+++ b/testsuite/usbmouse01/init.c
@@ -24,7 +24,10 @@
  * SUCH DAMAGE.
  */
 
-/*
+/**
+ * @file
+ *
+ * USB mouse test. RTEMS shell starts at the end of the test.
  * This test requires a USB mouse to be attached to a USB port.
  */
 
diff --git a/testsuite/usbserial01/init.c b/testsuite/usbserial01/init.c
index ef3a45f6..8e8fa627 100644
--- a/testsuite/usbserial01/init.c
+++ b/testsuite/usbserial01/init.c
@@ -24,6 +24,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * USB serial adapter test. RTEMS shell starts at the end of the test.
+ */
+
 #include <sys/malloc.h>
 #include <assert.h>
 #include <stdio.h>
diff --git a/testsuite/vlan01/test_main.c b/testsuite/vlan01/test_main.c
index 5f4082ee..741e8f51 100644
--- a/testsuite/vlan01/test_main.c
+++ b/testsuite/vlan01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * A vlan creation using ifconfig is tested.
+ */
+
 #include <sys/stat.h>
 #include <net/if.h>
 
diff --git a/testsuite/zerocopy01/test_main.c b/testsuite/zerocopy01/test_main.c
index 54051259..139f0cc8 100644
--- a/testsuite/zerocopy01/test_main.c
+++ b/testsuite/zerocopy01/test_main.c
@@ -29,6 +29,12 @@
  * SUCH DAMAGE.
  */
 
+/**
+ * @file
+ *
+ * Zerocopy test. Telnet daemon (telnetd) is initilized.
+ */
+
 #include <sys/types.h>
 #include <sys/param.h>
 #include <sys/mbuf.h>
-- 
2.12.3

More information about the devel mailing list