This is an automated email from the ASF dual-hosted git repository.
xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx-apps.git
commit 14f19f0e7d8aa7324d05decc76e7a9e490965b8b
Author: raiden00pl <raide...@railab.me>
AuthorDate: Tue Oct 24 14:05:20 2023 +0200
remove testing/xxx/README.md. Migrated to Documentation/applications/testing
---
testing/README.md | 165 ----------------------------------------
testing/arch_libc/README.md | 13 ----
testing/cxxtest/README.md | 27 -------
testing/fopencookie/README.md | 13 ----
testing/fstest/README.md | 25 ------
testing/mtd_config_fs/README.md | 16 ----
testing/nxffs/README.md | 6 --
testing/smart/README.md | 23 ------
testing/smart_test/README.md | 26 -------
9 files changed, 314 deletions(-)
diff --git a/testing/README.md b/testing/README.md
deleted file mode 100644
index ae1eae6ed..000000000
--- a/testing/README.md
+++ /dev/null
@@ -1,165 +0,0 @@
-# Testing
-
-The `apps/testing` directory is used to build NuttX-specific tests and to
-include external testing frameworks.
-
-There is overlap between what you will find in `apps/examples` and
-`apps/testing` in the sense that there are also tests in `apps/examples` as
-well. Those tests, however, can also be used to illustrate usage of a NuttX
-feature. Most of the tests in `apps/testing`, on the other hand, are pure tests
-with little value as usage examples.
-
-## `cxxtest`
-
-This is a test of the C++ standard library. At present a port of the uClibc++
-C++ library is available. Due to licensing issues, the uClibc++ C++ library is
-not included in the NuttX source tree by default, but must be installed (see
the
-`README.txt` file in the uClibc++ download package for installation).
-
-The uClibc++ test includes simple test of:
-
-- iostreams,
-- STL,
-- RTTI, and
-- Exceptions
-
-### Example Configuration Options
-
-- `CONFIG_TESTING_CXXTEST=y` – Eanbles the example
-
-### Other Required Configuration Settings
-
-Other NuttX setting that are required include:
-
-- `CONFIG_HAVE_CXX=y`
-- `CONFIG_HAVE_CXXINITIALIZE=y`
-- `CONFIG_UCLIBCXX=y` or `CONFIG_LIBCXX=y`
-
-Additional uClibc++/libcxx settings may be required in your build environment.
-
-## `fstest`
-
-This is a generic file system test that derives from `testing/nxffs`. It was
-created to test the tmpfs file system, but should work with any file system
-provided that all initialization has already been performed prior to starting
-the test.
-
-This test a a general test for any file system, but includes some specific
hooks
-for the SPIFFS file system.
-
-- `CONFIG_TESTING_FSTEST` – Enable the file system example.
-- `CONFIG_TESTING_FSTEST_MAXNAME` – Determines the maximum size of names used
in
- the filesystem.
-- `CONFIG_TESTING_FSTEST_MAXFILE` – Determines the maximum size of a file.
-- `CONFIG_TESTING_FSTEST_MAXIO` – Max I/O, default `347`.
-- `CONFIG_TESTING_FSTEST_MAXOPEN` – Max open files.
-- `CONFIG_TESTING_FSTEST_MOUNTPT` – Path where the file system is mounted.
-- `CONFIG_TESTING_FSTEST_NLOOPS` – Number of test loops. default `100`.
-- `CONFIG_TESTING_FSTEST_VERBOSE` – Verbose output.
-
-## `mm`
-
-This is a simple test of the memory manager.
-
-## `nxffs`
-
-This is a test of the NuttX NXFFS FLASH file system. This is an NXFFS stress
-test and beats on the file system very hard. It should only be used in a
-simulation environment! Putting this NXFFS test on real hardware will most
-likely destroy your FLASH. You have been warned.
-
-## `ostest`
-
-This is the NuttX _qualification_ suite. It attempts to exercise a broad set of
-OS functionality. Its coverage is not very extensive as of this writing, but it
-is used to qualify each NuttX release.
-
-The behavior of the `ostest` can be modified with the following settings in the
-`boards/<arch>/<chip>/<board>/configs/<config>/defconfig` file:
-
-- `CONFIG_NSH_BUILTIN_APPS` – Build the OS test example as an NSH built-in
- application.
-- `CONFIG_TESTING_OSTEST_LOOPS` – Used to control the number of executions of
- the test. If undefined, the test executes one time. If defined to be zero,
- the test runs forever.
-
-- `CONFIG_TESTING_OSTEST_STACKSIZE` – Used to create the ostest task. Default
is
- `8192`.
-- `CONFIG_TESTING_OSTEST_NBARRIER_THREADS` – Specifies the number of threads to
- create in the barrier test. The default is 8 but a smaller number may be
- needed on systems without sufficient memory to start so many threads.
-
-- `CONFIG_TESTING_OSTEST_RR_RANGE` – During round-robin scheduling test two
- threads are created. Each of the threads searches for prime numbers in the
- configurable range, doing that configurable number of times. This value
- specifies the end of search range and together with number of runs allows
to
- configure the length of this test – it should last at least a few tens of
- seconds. Allowed values `[1; 32767]`, default `10000`.
-
-- `CONFIG_TESTING_OSTEST_RR_RUNS` – During round-robin scheduling test two
- threads are created. Each of the threads searches for prime numbers in the
- configurable range, doing that configurable number of times.
-
-## `smart` SMART File System
-
-This is a test of the SMART file system that derives from `testing/nxffs`.
-
-- `CONFIG_TESTING_SMART` – Enable the SMART file system example.
-
-- `CONFIG_TESTING_SMART_ARCHINIT` – The default is to use the RAM MTD device at
- `drivers/mtd/rammtd.c`. But an architecture-specific MTD driver can be used
- instead by defining `CONFIG_TESTING_SMART_ARCHINIT`. In this case, the
- initialization logic will call `smart_archinitialize()` to obtain the MTD
- driver instance.
-
-- `CONFIG_TESTING_SMART_NEBLOCKS` – When `CONFIG_TESTING_SMART_ARCHINIT` is not
- defined, this test will use the RAM MTD device at `drivers/mtd/rammtd.c` to
- simulate FLASH. In this case, this value must be provided to give the number
- of erase blocks in MTD RAM device. The size of the allocated RAM drive will
- be: `CONFIG_RAMMTD_ERASESIZE * CONFIG_TESTING_SMART_NEBLOCKS`.
-
-- `CONFIG_TESTING_SMART_MAXNAME` – Determines the maximum size of names used in
- the filesystem.
-
-- `CONFIG_TESTING_SMART_MAXFILE` – Determines the maximum size of a file.
-- `CONFIG_TESTING_SMART_MAXIO` – Max I/O, default `347`.
-- `CONFIG_TESTING_SMART_MAXOPEN` – Max open files.
-- `CONFIG_TESTING_SMART_MOUNTPT` – SMART mountpoint.
-- `CONFIG_TESTING_SMART_NLOOPS` – Number of test loops. default `100`.
-- `CONFIG_TESTING_SMART_VERBOSE` – Verbose output.
-
-## `smart_test` SMART File System
-
-Performs a file-based test on a SMART (or any) filesystem. Validates seek,
-append and seek-with-write operations.
-
-* `CONFIG_TESTING_SMART_TEST=y`
-
-```
-Author: Ken Pettit
- Date: April 24, 2013
-```
-
-Performs a file-based test on a SMART (or any) filesystem. Validates seek,
-append and seek-with-write operations.
-
-```
-Usage:
-
- flash_test mtdblock_device
-
-Additional options:
-
- --force to replace existing installation
-```
-
-## `smp`
-
-This is a simple test for SMP functionality. It is basically just the pthread
-barrier test with some custom instrumentation.
-
-## `unity`
-
-Unity is a unit testing framework for C developed by ThrowTheSwitch.org:
-
-http://www.throwtheswitch.org/unity
diff --git a/testing/arch_libc/README.md b/testing/arch_libc/README.md
deleted file mode 100644
index c45f062c7..000000000
--- a/testing/arch_libc/README.md
+++ /dev/null
@@ -1,13 +0,0 @@
-# Testing / `arch_libc` Arch-specific libc Test
-
-This is a test for arch-specific libc function. Arch-specific libc functions
are often implemented in
-assembly language, here is the test for these functions. The test focuses on
key features in assembly
-language, including aligned access, speed, callee saved register check and so
on.
-Currently, the test only contains a subset of possible arch-specific libc
functions. You are welcomed
-to put more cases here.
-
-- `CONFIG_TESTING_ARCH_LIBC` – Enable the test.
-- `CONFIG_TESTING_ARCH_LIBC_XXXXX` – Enable test for function XXXXX.
-
-EXAMPLE
- arch_libc - Run the test.
diff --git a/testing/cxxtest/README.md b/testing/cxxtest/README.md
deleted file mode 100644
index 28072cf55..000000000
--- a/testing/cxxtest/README.md
+++ /dev/null
@@ -1,27 +0,0 @@
-# Testing / `cxxtest` C++ STL
-
-This is a test of the C++ standard library. At present a port of the uClibc++
-C++ library is available. Due to licensing issues, the uClibc++ C++ library is
-not included in the NuttX source tree by default, but must be installed (see
the
-`README.txt` file in the uClibc++ download package for installation).
-
-The uClibc++ test includes simple test of:
-
-- iostreams,
-- STL,
-- RTTI, and
-- Exceptions
-
-## Example Configuration Options
-
-- `CONFIG_TESTING_CXXTEST=y` – Enables the example
-
-## Other Required Configuration Settings
-
-Other NuttX setting that are required include:
-
-- `CONFIG_HAVE_CXX=y`
-- `CONFIG_HAVE_CXXINITIALIZE=y`
-- `CONFIG_UCLIBCXX=y` or `CONFIG_LIBCXX=y`
-
-Additional `uClibc++/libcxx` settings may be required in your build
environment.
diff --git a/testing/fopencookie/README.md b/testing/fopencookie/README.md
deleted file mode 100644
index d24d04733..000000000
--- a/testing/fopencookie/README.md
+++ /dev/null
@@ -1,13 +0,0 @@
-# Testing / `fopencookie` Fopencookie
-
-Performs a basic operations with fopencookie call.
-
-```conf
-CONFIG_TESTING_SMART_TEST=y
-```
-
-```
-Usage:
-
- fopencookie
-```
diff --git a/testing/fstest/README.md b/testing/fstest/README.md
deleted file mode 100644
index 34d03be31..000000000
--- a/testing/fstest/README.md
+++ /dev/null
@@ -1,25 +0,0 @@
-# Testing / `fstest` Generic File System Test
-
-This is a generic file system test that derives from `testing/nxffs`. It was
-created to test the tmpfs file system, but should work with any file system
-provided that all initialization has already been performed prior to starting
-the test.
-
-This test a a general test for any file system, but includes some specific
hooks
-for the SPIFFS file system.
-
-- `CONFIG_TESTING_FSTEST` – Enable the file system example.
-- `CONFIG_TESTING_FSTEST_MAXNAME` – Determines the maximum size of names used
in
- the filesystem.
-- `CONFIG_TESTING_FSTEST_MAXFILE` – Determines the maximum size of a file.
-- `CONFIG_TESTING_FSTEST_MAXIO` – Max I/O, default `347`.
-- `CONFIG_TESTING_FSTEST_MAXOPEN` – Max open files.
-- `CONFIG_TESTING_FSTEST_MOUNTPT` – Path where the file system is mounted.
-- `CONFIG_TESTING_FSTEST_NLOOPS` – Number of test loops. default `100`.
-- `CONFIG_TESTING_FSTEST_VERBOSE` – Verbose output.
-
-EXAMPLE
- fstest -m /mnt -n 10 – Test /mnt 10 times
- fstest -h – Get help message
- fstest – Test path define by `CONFIG_TESTING_FSTEST_MOUNTPT`
- `CONFIG_TESTING_FSTEST_NLOOPS` times
diff --git a/testing/mtd_config_fs/README.md b/testing/mtd_config_fs/README.md
deleted file mode 100644
index fdea6a85b..000000000
--- a/testing/mtd_config_fs/README.md
+++ /dev/null
@@ -1,16 +0,0 @@
-# Testing / `mtd_nvs` MTD non-volatile storage Test
-
-This is a test for MTD non-volatile storage. MTD non-volatile storage was
originally
-implemented in Zephyr by Laczen. We made several modification to the original
design.
-The main purpose of those modification was:
-1. support C-string key in nvs API(Original design only support uint16_t as
key)
-2. Meanwhile achieve better performance by limiting flash read
times(Theoratically
-better than Zephyr subsys/settings, which is based on original NVS).
-
-
-- `CONFIG_TESTING_FAILSAFE_MTD_CONFIG` – Enable the test.
-- `CONFIG_TESTING_FAILSAFE_MTD_CONFIG_VERBOSE` – Verbose output.
-
-EXAMPLE
- mtdconfig_fs_test -m /dev/config – Test MTD NVS on /dev/config
- mtdconfig_fs_test -h – Get help message
diff --git a/testing/nxffs/README.md b/testing/nxffs/README.md
deleted file mode 100644
index cf333eaa5..000000000
--- a/testing/nxffs/README.md
+++ /dev/null
@@ -1,6 +0,0 @@
-# Testing / `nxffs` NuttX NXFFS FLASH File System
-
-This is a test of the NuttX NXFFS FLASH file system. This is an NXFFS stress
-test and beats on the file system very hard. It should only be used in a
-simulation environment! Putting this NXFFS test on real hardware will most
-likely destroy your FLASH. You have been warned.
diff --git a/testing/smart/README.md b/testing/smart/README.md
deleted file mode 100644
index febf64bb1..000000000
--- a/testing/smart/README.md
+++ /dev/null
@@ -1,23 +0,0 @@
-# Testing / `smart` SMART File System
-
-This is a test of the SMART file system that derives from `testing/nxffs`.
-
-- `CONFIG_TESTING_SMART` – Enable the SMART file system example.
-- `CONFIG_TESTING_SMART_ARCHINIT` – The default is to use the RAM MTD device at
- `drivers/mtd/rammtd.c`. But an architecture-specific MTD driver can be used
- instead by defining `CONFIG_TESTING_SMART_ARCHINIT`. In this case, the
- initialization logic will call `smart_archinitialize()` to obtain the MTD
- driver instance.
-- `CONFIG_TESTING_SMART_NEBLOCKS` – When `CONFIG_TESTING_SMART_ARCHINIT` is not
- defined, this test will use the RAM MTD device at `drivers/mtd/rammtd.c` to
- simulate FLASH. In this case, this value must be provided to give the number
- of erase blocks in MTD RAM device. The size of the allocated RAM drive will
- be: `CONFIG_RAMMTD_ERASESIZE * CONFIG_TESTING_SMART_NEBLOCKS`.
-- `CONFIG_TESTING_SMART_MAXNAME` – Determines the maximum size of names used in
- the filesystem.
-- `CONFIG_TESTING_SMART_MAXFILE` – Determines the maximum size of a file.
-- `CONFIG_TESTING_SMART_MAXIO` – Max I/O, default `347`.
-- `CONFIG_TESTING_SMART_MAXOPEN` – Max open files.
-- `CONFIG_TESTING_SMART_MOUNTPT` – SMART mountpoint.
-- `CONFIG_TESTING_SMART_NLOOPS` – Number of test loops. default `100`.
-- `CONFIG_TESTING_SMART_VERBOSE` – Verbose output.
diff --git a/testing/smart_test/README.md b/testing/smart_test/README.md
deleted file mode 100644
index f0e6352f2..000000000
--- a/testing/smart_test/README.md
+++ /dev/null
@@ -1,26 +0,0 @@
-# Testing / `smart_test` SMART File System
-
-Performs a file-based test on a SMART (or any) filesystem. Validates seek,
-append and seek-with-write operations.
-
-```conf
-CONFIG_TESTING_SMART_TEST=y
-```
-
-```
-Author: Ken Pettit
- Date: April 24, 2013
-```
-
-Performs a file-based test on a SMART (or any) filesystem. Validates seek,
-append and seek-with-write operations.
-
-```
-Usage:
-
- flash_test mtdblock_device
-
- Additional options:
-
- --force to replace existing installation
-```
