Review Request JDK-8181834: Broken link in jdk.jdi module documentation

[serguei.spitsyn at oracle.com]

On 6/19/17 13:23, Mandy Chung wrote:
>> On Jun 19, 2017, at 1:17 PM, serguei.spitsyn at oracle.com wrote:
>>
>> Hi Mandy,
>>
>> I've built the docs with your patch and the link is still not resolved.
>> It points to the docs/api/specs/jpda/jpda.html
>>
> It should point to docs/specs/jpda/jpda.html. I verified in my build.

Good. I'm Ok with the fix then.

> Are you sure your build is correct?

No, I'm not sure.


>> But it is resolved if the patch is corrected with:
>>   + * <a href="${docRoot}/../../specs/jpda/jpda.html”>
>> Is it 9 or 10?
>>
> I want to fix this simple docs bug in JDK 9.

Ok, thanks.

-Serguei

>
> Mandy
>
>> Thanks,
>> Serguei
>>
>>
>> On 6/19/17 12:47, Mandy Chung wrote:
>>> Serguei,
>>>
>>> Can you review this patch fixing the link to JPDA?
>>>
>>> Mandy
>>>
>>>
>>>
>>> diff --git a/src/jdk.jdi/share/classes/module-info.java b/src/jdk.jdi/share/classes/module-info.java
>>> --- a/src/jdk.jdi/share/classes/module-info.java
>>> +++ b/src/jdk.jdi/share/classes/module-info.java
>>> @@ -39,12 +39,13 @@
>>>    * creation, etc. The ability to inspect a suspended thread's state, local
>>>    * variables, stack backtrace, etc.
>>>    * <p>
>>> - * JDI is the highest-layer of the Java Platform Debugger Architecture (JPDA).
>>> - * For more information on the Java Platform Debugger Architecture, see the <a
>>> - * href="{@docRoot}/../../../../technotes/guides/jpda/index.html"> Java
>>> - * Platform Debugger Architecture documentation</a> for this release and the <a
>>> - * href="http://java.sun.com/products/jpda">Java Platform Debugger Architecture
>>> - * website</a>.
>>> + * JDI is the highest-layer of the
>>> + * <a href="${docRoot}/../specs/jpda/jpda.html">
>>> + * Java Platform Debugger Architecture (JPDA)</a>.
>>> + * <p>
>>> + * This module includes a simple command-line debugger,
>>> + * <em>{@index jdb jdb tool}</em>.
>>> + *
>>>    * <h3>Global Exceptions</h3>
>>>    * <p>
>>>    * This section documents exceptions which apply to the entire API and are thus
>>> @@ -102,10 +103,6 @@
>>>    *   unloaded.
>>>    * </blockquote>
>>>    *
>>> - * <h3>jdb</h3>
>>> - *
>>> - * <em>{@index jdb jdb tool}</em> is a simple command-line debugger provided
>>> - * in this module.
>>>    *
>>>    * <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
>>>    * <dt class="simpleTagLabel">Tool Guides:
>>> @@ -119,6 +116,8 @@
>>>    *
>>>    * @moduleGraph
>>>    * @since 9
>>> + * @see <a href="${docRoot}/../specs/jpda/jpda.html">
>>> + * Java Platform Debugger Architecture (JPDA)</a>
>>>    */
>>>   module jdk.jdi {
>>>       requires jdk.attach;
>>>