[rtems commit] fstests and libtests: Add contents to multiple documentation files

Joel Sherrill joel at rtems.org
Wed Jan 8 18:41:34 UTC 2014


Module:    rtems
Branch:    master
Commit:    73a7713d8cd7594bf88339e156f57cb94128b265
Changeset: http://git.rtems.org/rtems/commit/?id=73a7713d8cd7594bf88339e156f57cb94128b265

Author:    Cynthia Rempel <cynt6007 at vandals.uidaho.edu>
Date:      Wed Jan  8 12:48:37 2014 -0600

fstests and libtests: Add contents to multiple documentation files

---

 testsuites/fstests/fsdosfssync01/fsdosfssync01.doc |   31 +++++++++++--
 testsuites/fstests/fsnofs01/fsnofs01.doc           |   50 ++++++++++++++++++-
 testsuites/libtests/block06/block06.doc            |   27 +++++++++--
 testsuites/libtests/complex/complex.doc            |   40 ++++++++++++++++
 testsuites/libtests/flashdisk01/flashdisk01.doc    |   21 +++++++-
 testsuites/libtests/monitor/monitor.doc            |   24 +++++++++
 testsuites/libtests/monitor02/monitor02.doc        |   17 +++++++
 testsuites/libtests/putenvtest/putenvtest.doc      |   22 +++++++++
 8 files changed, 217 insertions(+), 15 deletions(-)

diff --git a/testsuites/fstests/fsdosfssync01/fsdosfssync01.doc b/testsuites/fstests/fsdosfssync01/fsdosfssync01.doc
index 98b558a..0b0354c 100644
--- a/testsuites/fstests/fsdosfssync01/fsdosfssync01.doc
+++ b/testsuites/fstests/fsdosfssync01/fsdosfssync01.doc
@@ -1,11 +1,34 @@
+#  COPYRIGHT (c) 2014.
+#  On-Line Applications Research Corporation (OAR).
+#  Cynthia Rempel <cynthia at rtems.org>
+#  The license and distribution terms for this file may be
+#  found in the file LICENSE in this distribution or at
+#  http://www.rtems.com/license/LICENSE.
+#
+
 This file describes the directives and concepts tested by this test set.
 
 test set name: fsdosfssync01
 
 directives:
-
-  TBD
+  + close
+  + creat
+  + fsync
+  + lseek
+  + mount_and_make_target_path
+  + msdos_format
+  + open
+  + rtems_disk_io_initialize
+  + rtems_disk_fd_purge
+  + unmount
+  + write
 
 concepts:
-
-  TBD
+  + initializes the disk
+  + opens the disk
+  + formats, mounts the disk, creates a path
+  + creates a file uses fsync to clear the buffer and closes the file
+  + writes to a file, uses lseek to find the end of the file, clears the buffer
+    and closes the file
+  + checks the file size
+  + unmounts the filesystem and closes the disk
\ No newline at end of file
diff --git a/testsuites/fstests/fsnofs01/fsnofs01.doc b/testsuites/fstests/fsnofs01/fsnofs01.doc
index 5943345..a43189b 100644
--- a/testsuites/fstests/fsnofs01/fsnofs01.doc
+++ b/testsuites/fstests/fsnofs01/fsnofs01.doc
@@ -1,11 +1,55 @@
+#  COPYRIGHT (c) 2014.
+#  On-Line Applications Research Corporation (OAR).
+#  Cynthia Rempel <cynthia at rtems.org>
+#  The license and distribution terms for this file may be
+#  found in the file LICENSE in this distribution or at
+#  http://www.rtems.com/license/LICENSE.
+#
 This file describes the directives and concepts tested by this test set.
 
 test set name: fsnofs01
 
 directives:
+  + access
+  + chdir
+  + chmod
+  + chown
+  + chroot
+  + lchown
+  + link
+  + lstat
+  + mkdir
+  + mkfifo
+  + mknod
+  + open
+  + pathconf
+  + readlink
+  + rename
+  + rtems_chain_head
+  + rtems_chain_tail
+  + rtems_filesystem_global_location_obtain
+  + rtems_filesystem_global_location_release
+  + rtems_filesystem_location_copy
+  + rtems_filesystem_location_copy_and_detach
+  + rtems_filesystem_location_detach
+  + rtems_filesystem_location_free
+  + rtems_filesystem_global_location_obtain_null
+  + rtems_libio_set_private_env
+  + rtems_libio_share_private_env
+  + rtems_libio_use_global_env
+  + rmdir
+  + stat
+  + statvfs
+  + symlink
+  + truncate
+  + unlink
+  + utime
 
-  TBD
-
+  
 concepts:
+  + tests obtaining and replacing file system locations
+  + tests error handling of attempting to obtain and replace null file system
+    locations
+  + tests various calls to the filesystem
+  + tests user environment options
 
-  TBD
diff --git a/testsuites/libtests/block06/block06.doc b/testsuites/libtests/block06/block06.doc
index 4c1eb9a..224127c 100644
--- a/testsuites/libtests/block06/block06.doc
+++ b/testsuites/libtests/block06/block06.doc
@@ -1,4 +1,4 @@
-# Copyright 2008 Chris Johns (chrisj at rtems.org)
+# Copyright 2008-2014 Chris Johns (chrisj at rtems.org)
 #
 # The license and distribution terms for this file may be
 # found in the file LICENSE in this distribution or at
@@ -9,10 +9,27 @@ This file describes the directives and concepts tested by this test set.
 
 test set name: block06
 
-directives:
+Test 1: Get task 0 to get buffer 0 from the pool then release it twice.
 
-  TODO
+Test 2: Get task 0 to get buffers 0 -> 4 from the pool hold them. Then get
+        task 1 and task 2 to get them with blocking. The 2 tasks tests the
+        priority blocking on the buffer.
 
-concepts:
+Test 3: Read a block from disk into the buffer, modify the block and release
+        it modified. Use a block great then 4 because 0 -> 4 are in the cache.
+
+Test 4: Read every buffer in the pool and hold. Then get task 1 to ask for
+        another buffer that is being accessed. It will block waiting for it to
+		appear.
+ 
+Test 5: Read every buffer in the pool and hold. Then get task 1 to ask for a
+        new buffer. It will block waiting for one to appear.
+
+Test 6: Get 5 buffers, release modify 4 then sync the last.
+
+Test 7: Get 5 buffers, release modify them all then sync the device.
+
+Test 8: Get 5 buffers, release modify the last 2 then the reset from 0.
+
+TODO: if possible, break into separate tests
 
-  TODO
diff --git a/testsuites/libtests/complex/complex.doc b/testsuites/libtests/complex/complex.doc
new file mode 100644
index 0000000..219bdd7
--- /dev/null
+++ b/testsuites/libtests/complex/complex.doc
@@ -0,0 +1,40 @@
+#  COPYRIGHT (c) 2014.
+#  On-Line Applications Research Corporation (OAR).
+#  Cynthia Rempel <cynthia at rtems.org>
+#  The license and distribution terms for this file may be
+#  found in the file LICENSE in this distribution or at
+#  http://www.rtems.com/license/LICENSE.
+#
+This file describes the directives and concepts tested by this test set.
+
+test set name: complex
+
+directives:
+  + cabs
+  + cacos
+  + cacosh
+  + carg
+  + casin
+  + casinh
+  + catan
+  + catanh
+  + ccos
+  + ccosh
+  + cexp
+  + cimag
+  + clog
+  + conj
+  + cpow
+  + cproj
+  + creal
+  + csin
+  + csinh
+  + csqrt
+  + ctan
+  + ctanh
+  + printf
+  
+concepts:
+  + verifies the functionality of complex mathematical routines
+  + printf using float and long double formats
+
diff --git a/testsuites/libtests/flashdisk01/flashdisk01.doc b/testsuites/libtests/flashdisk01/flashdisk01.doc
index 6bb1205..823f7a5 100644
--- a/testsuites/libtests/flashdisk01/flashdisk01.doc
+++ b/testsuites/libtests/flashdisk01/flashdisk01.doc
@@ -1,11 +1,26 @@
+#  COPYRIGHT (c) 2014.
+#  On-Line Applications Research Corporation (OAR).
+#  Cynthia Rempel <cynthia at rtems.org>
+#  The license and distribution terms for this file may be
+#  found in the file LICENSE in this distribution or at
+#  http://www.rtems.com/license/LICENSE.
+#
 This file describes the directives and concepts tested by this test set.
 
 test set name: flashdisk01
 
 directives:
-
-  TBD
+  + close
+  + ioctl
+  + mkdir
+  + mknod
+  + mount
+  + mount_and_make_target_path
+  + open
+  + rtems_rfs_format
+  + unmount
 
 concepts:
+  + tests whether a flash filesystem can be mounted and unmounted
+ 
 
-  TBD
diff --git a/testsuites/libtests/monitor/monitor.doc b/testsuites/libtests/monitor/monitor.doc
new file mode 100644
index 0000000..3325356
--- /dev/null
+++ b/testsuites/libtests/monitor/monitor.doc
@@ -0,0 +1,24 @@
+#  COPYRIGHT (c) 2014.
+#  On-Line Applications Research Corporation (OAR).
+#  Cynthia Rempel <cynthia at rtems.org>
+#  The license and distribution terms for this file may be
+#  found in the file LICENSE in this distribution or at
+#  http://www.rtems.com/license/LICENSE.
+#
+This file describes the directives and concepts tested by this test set.
+
+test set name: monitor
+
+directives:
+  + rtems_monitor_init
+  + rtems_shell_wait_for_input
+  + rtems_task_create
+  + rtems_task_delete
+  + rtems_task_start
+  + rtems_task_wake_after
+  
+concepts:
+  + start the monitor task
+  
+NOTE: the monitor task can be used to obtain information about a variety of
+      RTEMS objects.
diff --git a/testsuites/libtests/monitor02/monitor02.doc b/testsuites/libtests/monitor02/monitor02.doc
new file mode 100644
index 0000000..7fe98b3
--- /dev/null
+++ b/testsuites/libtests/monitor02/monitor02.doc
@@ -0,0 +1,17 @@
+#  COPYRIGHT (c) 2014.
+#  On-Line Applications Research Corporation (OAR).
+#  Cynthia Rempel <cynthia at rtems.org>
+#  The license and distribution terms for this file may be
+#  found in the file LICENSE in this distribution or at
+#  http://www.rtems.com/license/LICENSE.
+#
+This file describes the directives and concepts tested by this test set.
+
+test set name: monitor02
+
+directives:
+  + rtems_shell_make_args
+  + rtems_shell_main_monitor
+  
+concepts:
+  + provide canned commands to the monitor
diff --git a/testsuites/libtests/putenvtest/putenvtest.doc b/testsuites/libtests/putenvtest/putenvtest.doc
new file mode 100644
index 0000000..7c2ec37
--- /dev/null
+++ b/testsuites/libtests/putenvtest/putenvtest.doc
@@ -0,0 +1,22 @@
+#  COPYRIGHT (c) 2014.
+#  On-Line Applications Research Corporation (OAR).
+#  Cynthia Rempel <cynthia at rtems.org>
+#  The license and distribution terms for this file may be
+#  found in the file LICENSE in this distribution or at
+#  http://www.rtems.com/license/LICENSE.
+#
+This file describes the directives and concepts tested by this test set.
+
+test set name: putenv
+
+directives:
+  + getenv
+  + putenv
+  
+concepts:
+  + sets the FOO environmental variable to BAR, and prints the result to the
+    screen
+
+TODO: add an rtems_assert statement verifying that the FOO environmental
+      variable is indeed BAR (in addition to/instead of printing to the screen)
+	  to ease automated reporting
\ No newline at end of file




More information about the vc mailing list