Add regresssion_samples explanation (#1230)

seladb · Nov 8, 2023 · 3227ad1 · 3227ad1
1 parent cfb1e35
commit 3227ad1
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/Tests/Fuzzers/RegressionTests/README.md b/Tests/Fuzzers/RegressionTests/README.md
@@ -0,0 +1,4 @@
+The files in `regression_samples` are basically pcap files (not necessarily valid ones) that triggered crashes in the past.
+Since the issues are fixed they don't trigger the crashes anymore.
+On every pull request an [ASAN](https://clang.llvm.org/docs/AddressSanitizer.html)/[USAN](https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html)/[MSAN](https://clang.llvm.org/docs/MemorySanitizer.html) instrumented build opens all of them one by one.
+If there is a crash - the pull request introduced memory corruption.