Merge pull request #73 from RalfJung/memleak

doctests should not be leaking memory any more

Author: RalfJung

README.md

@@ -9,26 +9,21 @@ Every night, a CI cron job runs the tests against the latest nightly, to make su
 To run the tests yourself, make sure you have Miri installed (`rustup component add miri`) and then run:
 
 ```shell
-# Unit tests and integration tests
-./run-test.sh core --lib --tests
-./run-test.sh alloc --lib --tests
-MIRIFLAGS="-Zmiri-disable-isolation" ./run-test.sh std --lib --tests -- --skip fs:: --skip net:: --skip process:: --skip sys::pal::
-# Doc tests
-MIRIFLAGS="-Zmiri-ignore-leaks" ./run-test.sh core --doc
-MIRIFLAGS="-Zmiri-ignore-leaks" ./run-test.sh alloc --doc
-MIRIFLAGS="-Zmiri-ignore-leaks -Zmiri-disable-isolation" ./run-test.sh std --doc -- --skip fs:: --skip net:: --skip process:: --skip sys::pal::
+MIRIFLAGS="-Zmiri-disable-isolation" ./run-test.sh core
+MIRIFLAGS="-Zmiri-disable-isolation" ./run-test.sh alloc
+MIRIFLAGS="-Zmiri-disable-isolation" ./run-test.sh std -- --skip fs:: --skip net:: --skip process:: --skip sys::pal::
 ```
 
 This will run the test suite of the standard library of your current toolchain.
 It will probably take 1-2h, so if you have specific parts of the standard library you want to test, use the usual `cargo test` filter mechanisms to narrow this down:
 all arguments are passed to `cargo test`, so arguments after `--` are passed to the test runner as usual.
-Doc tests have to be run separately as there are some (expected) memory leaks.
+Isolation is disabled as even in `core`, some doctests use file system accesses for demonstration purposes.
 For `std`, we cannot run *all* tests since they will use networking and file system APIs that we do not support.
 
 If you are working on the standard library and want to check that the tests pass with your modifications, set `MIRI_LIB_SRC` to the `library` folder of the checkout you are working in:
 
 ```shell
-MIRI_LIB_SRC=~/path/to/rustc/library ./run-test.sh core --lib --tests
+MIRI_LIB_SRC=~/path/to/rustc/library ./run-test.sh core -- test_name
 ```
 
 Here, `~/path/to/rustc` should be the directory containing `x.py`.

ci-test.sh

@@ -26,8 +26,8 @@ core)
             ./run-test.sh core --target $TARGET --lib --tests \
             2>&1 | ts -i '%.s  '
         echo "::endgroup::"
-        echo "::group::Testing core docs ($TARGET, ignore leaks)" && echo
-        MIRIFLAGS="$DEFAULTFLAGS -Zmiri-ignore-leaks -Zmiri-disable-isolation" \
+        echo "::group::Testing core docs ($TARGET)" && echo
+        MIRIFLAGS="$DEFAULTFLAGS -Zmiri-disable-isolation" \
             ./run-test.sh core --target $TARGET --doc \
             2>&1 | ts -i '%.s  '
         echo "::endgroup::"
@@ -42,8 +42,8 @@ alloc)
             ./run-test.sh alloc --target $TARGET --lib --tests \
             2>&1 | ts -i '%.s  '
         echo "::endgroup::"
-        echo "::group::Testing alloc docs ($TARGET, ignore leaks)"
-        MIRIFLAGS="$DEFAULTFLAGS -Zmiri-ignore-leaks -Zmiri-disable-isolation" \
+        echo "::group::Testing alloc docs ($TARGET)"
+        MIRIFLAGS="$DEFAULTFLAGS -Zmiri-disable-isolation" \
             ./run-test.sh alloc --target $TARGET --doc \
             2>&1 | ts -i '%.s  '
         echo "::endgroup::"
@@ -63,8 +63,8 @@ std)
             -- $(for M in $SKIP; do echo "--skip $M "; done) \
             2>&1 | ts -i '%.s  '
         echo "::endgroup::"
-        echo "::group::Testing std docs ($TARGET, ignore leaks)"
-        MIRIFLAGS="$DEFAULTFLAGS -Zmiri-ignore-leaks -Zmiri-disable-isolation" \
+        echo "::group::Testing std docs ($TARGET)"
+        MIRIFLAGS="$DEFAULTFLAGS -Zmiri-disable-isolation" \
             ./run-test.sh std --target $TARGET --doc \
             -- $(for M in $SKIP; do echo "--skip $M "; done) \
             2>&1 | ts -i '%.s  '

rust-version

@@ -1 +1 @@
-nightly-2024-07-01
+nightly-2024-07-15