From 44198b40e950c4f7fb79542d30fe4419d1e1f1d6 Mon Sep 17 00:00:00 2001
From: Manfred Riem <mriem@manorrock.com>
Date: Sun, 6 Oct 2024 08:55:48 -0500
Subject: [PATCH] Fixes #4037 - Add README describing how to debug with REST
 TCK

---
 external/coreprofile-tck/rest/README.md | 38 +++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 external/coreprofile-tck/rest/README.md

diff --git a/external/coreprofile-tck/rest/README.md b/external/coreprofile-tck/rest/README.md
new file mode 100644
index 000000000..17abe4bb4
--- /dev/null
+++ b/external/coreprofile-tck/rest/README.md
@@ -0,0 +1,38 @@
+README
+======
+
+The `runner` module runs the REST TCK tests so make sure you are in its 
+directory when you need to debug any tests.
+
+To run a single test, use the following command:
+
+```
+mvn -Dit.test=TestName verify
+```
+
+To run a single test in debug mode, use the following command:
+
+```
+mvn -Dmaven.surefire.debug -Dit.test=TestName verify 
+```
+
+To run a single test in debug mode with a specific port, use the following 
+command:
+
+```
+mvn -Dmaven.surefire.debug -Dmaven.surefire.debug.port=5005 -Dit.test=TestName verify
+```
+
+To run a single test in debug mode with a specific port and suspend, use the 
+following command:
+
+```
+mvn -Dmaven.surefire.debug -Dmaven.surefire.debug.port=5005 -Dmaven.surefire.debug.suspend=y -Dit.test=TestName verify
+```
+
+To run a single test and put Piranha in debug and susspend mode use the 
+following command:
+
+```
+mvn -Dpiranha.debug=true -Dpiranha.suspend=true -Dit.test=TestName verify
+```