Title: [295536] trunk/Source/bmalloc/libpas/ReadMe.md
Revision
295536
Author
[email protected]
Date
2022-06-14 14:17:40 -0700 (Tue, 14 Jun 2022)

Log Message

[libpas] Add documentation on running specific tests in libpas
https://bugs.webkit.org/show_bug.cgi?id=241610

Reviewed by Mark Lam.

Add documentation on running specific libpas test cases.

* Source/bmalloc/libpas/ReadMe.md:

Canonical link: https://commits.webkit.org/251541@main

Modified Paths

Diff

Modified: trunk/Source/bmalloc/libpas/ReadMe.md (295535 => 295536)


--- trunk/Source/bmalloc/libpas/ReadMe.md	2022-06-14 21:00:35 UTC (rev 295535)
+++ trunk/Source/bmalloc/libpas/ReadMe.md	2022-06-14 21:17:40 UTC (rev 295536)
@@ -17,23 +17,23 @@
 project (like bmalloc), which just pulls all of libpas' files into that
 project's build system.
 
-Build and test:
+Build and Test
 
     ./build_and_test.sh
 
-Just build:
+Build
 
     ./build.sh
 
-Just test:
+Test
 
     ./test.sh
 
-Clean:
+Clean
 
     ./clean.sh
 
-On my M1 machine, I usually do this:
+On my M1 machine, I usually do this
 
     ./build_and_test.sh -a arm64e
 
@@ -54,7 +54,14 @@
 take the same options (`-h`, `-c <config>`, `-s <sdk>`, `-a <arch>`,
 `-v <variant>`, `-t <target>`, and `-p <port>`).
 
+Libpas creates multiple binaries (`test_pas` and `chaos`) during compilation, which are used by `test.sh`. Calling these binaries directly may be preferred if you would like to test or debug just one or a handful of test cases.
 
+`test_pas` allows you to filter which test cases will be run. These are a few examples
+
+	  ./test_pas 'JITHeapTests' # Run all JIT heap tests
+	  ./test_pas 'testPGMSingleAlloc()' # Run specific test
+	  ./test_pas '(1):' # Run test case 1
+
 # Synopsis
 
 Libpas is a toolkit for creating memory allocators. When built as a dylib, it
_______________________________________________
webkit-changes mailing list
[email protected]
https://lists.webkit.org/mailman/listinfo/webkit-changes

Reply via email to