From c61afc03d9b562efb9fb9dda898abfb45c831fc9 Mon Sep 17 00:00:00 2001 From: Simeon Widdis Date: Wed, 4 Jun 2025 16:44:45 +0000 Subject: [PATCH 1/3] Add details to dev guide Signed-off-by: Simeon Widdis --- DEVELOPER_GUIDE.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/DEVELOPER_GUIDE.rst b/DEVELOPER_GUIDE.rst index f7798c9e92..684eaf6e28 100644 --- a/DEVELOPER_GUIDE.rst +++ b/DEVELOPER_GUIDE.rst @@ -87,6 +87,15 @@ Firstly you need to add the following configuration to the JVM used by your IDE. -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 +This is automatically applied if you pass the `debugJVM` flag when running. + +``` +gradlew opensearch-sql:run -DdebugJVM +``` + +To connect to the cluster with the debugger in an IDE, you'll need to connect to that port. +For IntelliJ, see [attaching to a remote process](https://www.jetbrains.com/help/idea/attach-to-process.html#attach-to-remote). + License Header -------------- From 0294532e5011e8b39a492acf6cbb7ce7157dfd8e Mon Sep 17 00:00:00 2001 From: Simeon Widdis Date: Wed, 4 Jun 2025 16:49:56 +0000 Subject: [PATCH 2/3] RST, not MD Signed-off-by: Simeon Widdis --- DEVELOPER_GUIDE.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/DEVELOPER_GUIDE.rst b/DEVELOPER_GUIDE.rst index 684eaf6e28..07b6664235 100644 --- a/DEVELOPER_GUIDE.rst +++ b/DEVELOPER_GUIDE.rst @@ -87,14 +87,15 @@ Firstly you need to add the following configuration to the JVM used by your IDE. -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 -This is automatically applied if you pass the `debugJVM` flag when running. +This is automatically applied if you pass the ``debugJVM`` flag when +running. -``` -gradlew opensearch-sql:run -DdebugJVM -``` +:: -To connect to the cluster with the debugger in an IDE, you'll need to connect to that port. -For IntelliJ, see [attaching to a remote process](https://www.jetbrains.com/help/idea/attach-to-process.html#attach-to-remote). + gradlew opensearch-sql:run -DdebugJVM + +To connect to the cluster with the debugger in an IDE, you’ll need to +connect to that port. For IntelliJ, see `attaching to a remote process `_. License Header -------------- From 000bb25991eceb856281969fae74a52fe2d7352a Mon Sep 17 00:00:00 2001 From: Simeon Widdis Date: Thu, 12 Jun 2025 12:00:58 -0700 Subject: [PATCH 3/3] Update DEVELOPER_GUIDE.rst Signed-off-by: Simeon Widdis --- DEVELOPER_GUIDE.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEVELOPER_GUIDE.rst b/DEVELOPER_GUIDE.rst index 07b6664235..d0d869e1d0 100644 --- a/DEVELOPER_GUIDE.rst +++ b/DEVELOPER_GUIDE.rst @@ -92,7 +92,7 @@ running. :: - gradlew opensearch-sql:run -DdebugJVM + ./gradlew opensearch-sql:run -DdebugJVM To connect to the cluster with the debugger in an IDE, you’ll need to connect to that port. For IntelliJ, see `attaching to a remote process `_.