[nuttx] branch master updated: Documentation: Add entry for sd_stress tool.

[xi...@apache.org]

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.git


The following commit(s) were added to refs/heads/master by this push:
     new c19c943835 Documentation: Add entry for sd_stress tool.
c19c943835 is described below

commit c19c943835fcc54424c09f3ff5ffb18b9342eee5
Author: Stuart Ianna <st...@motec.com.au>
AuthorDate: Wed Oct 25 11:12:07 2023 +1100

    Documentation: Add entry for sd_stress tool.
---
 .../applications/testing/sd_stress/index.rst       | 42 ++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/Documentation/applications/testing/sd_stress/index.rst b/Documentation/applications/testing/sd_stress/index.rst
new file mode 100644
index 0000000000..81f16ed1d6
--- /dev/null
+++ b/Documentation/applications/testing/sd_stress/index.rst
@@ -0,0 +1,42 @@
+================================
+``sd_stress`` SD card or mount point stress test
+================================
+
+Performs stress testing on SD card or other mount points using the file system layer.
+
+A single test run.
+
+- Creates a staging directory
+- Creates multiple files in this directory. Writing, reading and verifying a set of bytes from each one.
+- Renames the staging directory.
+- Remove the created files from the renamed directory.
+- Remove the renamed directory.
+
+The following runtime options are available::
+
+  nsh> sdstress -h
+  Stress test on a mount point
+  sdstress: [-r] [-b] [-f]
+    -r   Number of runs (1-10000), default 32
+    -b   Number of bytes (1-10000), default 4096
+    -f   Number of files (1-999), default 64
+
+
+An example of a completed test::
+
+  nsh> sdstress -b 4096 -f 32 -r 5
+  Start stress test with 32 files, 4096 bytes and 5 iterations.
+  iteration 0 took 4063.445 ms: OK
+  iteration 1 took 4158.073 ms: OK
+  iteration 2 took 4216.130 ms: OK
+  iteration 3 took 4295.138 ms: OK
+  iteration 4 took 4352.903 ms: OK
+  Test OK: Average time: 4217.138 ms
+
+The following Kconfig options can be used to configure the application at compile time.
+
+- ``CONFIG_TESTING_SD_STRESS`` - Enable the stress test utility.
+- ``CONFIG_TESTING_SD_STRESS_PROGNAME`` - The name of the program registered with nsh.
+- ``CONFIG_TESTING_SD_STRESS_PRIORITY`` - The priority of the task.
+- ``CONFIG_TESTING_SD_STRESS_STACKSIZE`` - The stacksize of the task.
+- ``CONFIG_TESTING_SD_STRESS_STACKSIZE`` - The mountpoint of the filesystem to test.