summaryrefslogtreecommitdiffstatshomepage
path: root/tools
diff options
context:
space:
mode:
authorJos Verlinde <jos_verlinde@hotmail.com>2025-04-07 23:14:17 +0200
committerDamien George <damien@micropython.org>2025-04-09 10:51:48 +1000
commitef8282c717be8363e9a04ebf2b9d843e2485604f (patch)
treead1f20df38148a0ec0f4128fb04cdce62749968f /tools
parent72d4c409418b2d35be41b7b04f1802457309bc6d (diff)
downloadmicropython-ef8282c717be8363e9a04ebf2b9d843e2485604f.tar.gz
micropython-ef8282c717be8363e9a04ebf2b9d843e2485604f.zip
docs/reference/mpremote: Update docs for mpremote rm -r.
Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>
Diffstat (limited to 'tools')
-rw-r--r--tools/mpremote/tests/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/tools/mpremote/tests/README.md b/tools/mpremote/tests/README.md
index 5b924d2fb8..d1d77f1fb5 100644
--- a/tools/mpremote/tests/README.md
+++ b/tools/mpremote/tests/README.md
@@ -4,11 +4,26 @@ This directory contains a set of tests for `mpremote`.
Requirements:
- A device running MicroPython connected to a serial port on the host.
+- The device you are testing against must be flashed with a firmware of the same build
+ as `mpremote`.
+- If the device has an SDcard or other vfs mounted, the vfs's filesystem must be empty
+ to pass the filesystem test.
- Python 3.x, `bash` and various Unix tools such as `find`, `mktemp`, `sed`, `sort`, `tr`.
+- To test on Windows, you can either:
+ - Run the (Linux) tests in WSL2 against a USB device that is passed though to WSL2.
+ - Use the `Git Bash` terminal to run the tests against a device connected to a COM
+ port. _Note:_ While the tests will run in `Git Bash`, several will throw false
+ positive errors due to differences in the way that TMP files are logged and and
+ several other details.
To run the tests do:
+ $ cd tools/mpremote/tests
$ ./run-mpremote-tests.sh
+To run a single test do:
+
+ $ ./run-mpremote-tests.sh test_filesystem.sh
+
Each test should print "OK" if it passed. Otherwise it will print "CRASH", or "FAIL"
and a diff of the expected and actual test output.