RFR: JDK-8211324: Link to java.lang.ThreadGroup in JDWP spec is broken

[Gary Adams]

Alan suggested in the bug report for the broken link from the jdwp-protocol
spec to the java/lang/ThreadGroup documentation to simply remove the
href link. Another possibility is to simply update the link to include
the java.base
subdirectory.

I don't think the doc structure changes very often so either solution
seems fine to me.

diff --git a/make/data/jdwp/jdwp.spec b/make/data/jdwp/jdwp.spec
--- a/make/data/jdwp/jdwp.spec
+++ b/make/data/jdwp/jdwp.spec
@@ -2185,7 +2185,7 @@
"in this thread group. Threads and thread groups in child "
"thread groups are not included. "
"A thread is alive if it has been started and has not yet been
stopped. "
- "See <a
href=../../../api/java/lang/ThreadGroup.html>java.lang.ThreadGroup </a>
+ "See <a
href=../../api/java.base/java/lang/ThreadGroup.html>java.lang.ThreadGroup </a>
"for information about active ThreadGroups.
(Out
(threadGroupObject group "The thread group object ID. ")

[Chris Hegarty]

The updated link looks ok to me.

-Chris

Post by Gary Adams
Alan suggested in the bug report for the broken link from the jdwp-protocol
spec to the java/lang/ThreadGroup documentation to simply remove the
href link. Another possibility is to simply update the link to include the java.base
subdirectory.
I don't think the doc structure changes very often so either solution
seems fine to me.
diff --git a/make/data/jdwp/jdwp.spec b/make/data/jdwp/jdwp.spec
--- a/make/data/jdwp/jdwp.spec
+++ b/make/data/jdwp/jdwp.spec
@@ -2185,7 +2185,7 @@
"in this thread group. Threads and thread groups in child "
"thread groups are not included. "
"A thread is alive if it has been started and has not yet been stopped. "
- "See <a href=../../../api/java/lang/ThreadGroup.html>java.lang.ThreadGroup </a>
+ "See <a href=../../api/java.base/java/lang/ThreadGroup.html>java.lang.ThreadGroup </a>
"for information about active ThreadGroups.
(Out
(threadGroupObject group "The thread group object ID. ")

[s***@oracle.com]

Hi Gary,

+1

Thanks,
Serguei

Post by Chris Hegarty
The updated link looks ok to me.
-Chris

Post by Gary Adams
Alan suggested in the bug report for the broken link from the jdwp-protocol
spec to the java/lang/ThreadGroup documentation to simply remove the
href link. Another possibility is to simply update the link to include the java.base
subdirectory.
I don't think the doc structure changes very often so either solution
seems fine to me.
diff --git a/make/data/jdwp/jdwp.spec b/make/data/jdwp/jdwp.spec
--- a/make/data/jdwp/jdwp.spec
+++ b/make/data/jdwp/jdwp.spec
@@ -2185,7 +2185,7 @@
"in this thread group. Threads and thread groups in child "
"thread groups are not included. "
"A thread is alive if it has been started and has not yet been stopped. "
- "See <a href=../../../api/java/lang/ThreadGroup.html>java.lang.ThreadGroup </a>
+ "See <a href=../../api/java.base/java/lang/ThreadGroup.html>java.lang.ThreadGroup </a>
"for information about active ThreadGroups.
(Out
(threadGroupObject group "The thread group object ID. ")

[Gary Adams]

Patch attached.

I'll need a sponsor for the push.

Post by s***@oracle.com
Hi Gary,
+1
Thanks,
Serguei

Post by Chris Hegarty
The updated link looks ok to me.
-Chris

Post by Gary Adams
Alan suggested in the bug report for the broken link from the jdwp-protocol
spec to the java/lang/ThreadGroup documentation to simply remove the
href link. Another possibility is to simply update the link to include the java.base
subdirectory.
I don't think the doc structure changes very often so either solution
seems fine to me.
diff --git a/make/data/jdwp/jdwp.spec b/make/data/jdwp/jdwp.spec
--- a/make/data/jdwp/jdwp.spec
+++ b/make/data/jdwp/jdwp.spec
@@ -2185,7 +2185,7 @@
"in this thread group. Threads and thread groups in child "
"thread groups are not included. "
"A thread is alive if it has been started and has not yet been stopped. "
- "See <a
href=../../../api/java/lang/ThreadGroup.html>java.lang.ThreadGroup </a>
+ "See <a
href=../../api/java.base/java/lang/ThreadGroup.html>java.lang.ThreadGroup </a>
"for information about active ThreadGroups.
(Out
(threadGroupObject group "The thread group object ID. ")

[s***@oracle.com]

I'll push it.

Thanks,
Serguei

Post by Gary Adams
Patch attached.
I'll need a sponsor for the push.

Post by s***@oracle.com
Hi Gary,
+1
Thanks,
Serguei

Post by Chris Hegarty
The updated link looks ok to me.
-Chris

Post by Gary Adams
Alan suggested in the bug report for the broken link from the jdwp-protocol
spec to the java/lang/ThreadGroup documentation to simply remove the
href link. Another possibility is to simply update the link to include the java.base
subdirectory.
I don't think the doc structure changes very often so either solution
seems fine to me.
diff --git a/make/data/jdwp/jdwp.spec b/make/data/jdwp/jdwp.spec
--- a/make/data/jdwp/jdwp.spec
+++ b/make/data/jdwp/jdwp.spec
@@ -2185,7 +2185,7 @@
         "in this thread group. Threads and thread groups in child "
         "thread groups are not included. "
         "A thread is alive if it has been started and has not yet
been stopped. "
-        "See <a
href=../../../api/java/lang/ThreadGroup.html>java.lang.ThreadGroup </a>
+        "See <a
href=../../api/java.base/java/lang/ThreadGroup.html>java.lang.ThreadGroup </a>
         "for information about active ThreadGroups.
         (Out
             (threadGroupObject group "The thread group object ID. ")

[Alan Bateman]

Post by Gary Adams
Alan suggested in the bug report for the broken link from the
jdwp-protocol
spec to the java/lang/ThreadGroup documentation to simply remove the
href link. Another possibility is to simply update the link to include
the java.base
subdirectory.

My comment in the bug is just a concern is that spec <--> API refs have
been very difficult to keep working. In this case, there is only one
unimportant link from the JDWP spec to the API docs. I'm okay with the
patch you have too.

-Alan