[prev in list] [next in list] [prev in thread] [next in thread] 

List:       openjdk-serviceability-dev
Subject:    Re: JDK 14 RFR(XXS): 8229847: AttachProvider javadoc page needs an update
From:       serguei.spitsyn () oracle ! com
Date:       2020-01-10 1:28:37
Message-ID: 2fe4be63-0e25-5563-7a68-3a9e447f52d4 () oracle ! com
[Download RAW message or body]

Thanks, David!
Serguei

On 1/9/20 5:22 PM, David Holmes wrote:
> +1
>
> Thanks,
> David
>
> On 10/01/2020 9:51 am, Alex Menkov wrote:
>> LGTM
>>
>> --alex
>>
>> On 01/09/2020 13:54, serguei.spitsyn@oracle.com wrote:
>>> Hi David and Alex,
>>>
>>> The updated webrev is:
>>> http://cr.openjdk.java.net/~sspitsyn/webrevs/2020/AttachProvider-doc.1/
>>>
>>>
>>> Thanks,
>>> Serguei
>>>
>>> On 1/8/20 3:50 PM, serguei.spitsyn@oracle.com wrote:
>>>> Hi David,
>>>>
>>>>
>>>> On 1/8/20 14:54, David Holmes wrote:
>>>>> Hi Serguei,
>>>>>
>>>>> On 9/01/2020 7:42 am, serguei.spitsyn@oracle.com wrote:
>>>>>> Please, review a trivial fix for the doc bug:
>>>>>>    https://bugs.openjdk.java.net/browse/JDK-8229847
>>>>>>
>>>>>> The patch is:
>>>>>>
>>>>>> diff --git 
>>>>>> a/src/jdk.attach/share/classes/com/sun/tools/attach/spi/AttachProvider.java 
>>>>>> b/src/jdk.attach/share/classes/com/sun/tools/attach/spi/AttachProvider.java 
>>>>>>
>>>>>> --- 
>>>>>> a/src/jdk.attach/share/classes/com/sun/tools/attach/spi/AttachProvider.java 
>>>>>>
>>>>>> +++ 
>>>>>> b/src/jdk.attach/share/classes/com/sun/tools/attach/spi/AttachProvider.java 
>>>>>>
>>>>>> @@ -46,16 +46,16 @@
>>>>>>    * <p> An attach provider implementation is typically tied to a 
>>>>>> Java virtual
>>>>>>    * machine implementation, version, or even mode of operation. 
>>>>>> That is, a specific
>>>>>>    * provider implementation will typically only be capable of 
>>>>>> attaching to
>>>>>> - * a specific Java virtual machine implementation or version. 
>>>>>> For example, Sun's
>>>>>> + * a specific Java virtual machine implementation or version. 
>>>>>> For example, Oracle's
>>>>>>    * JDK implementation ships with provider implementations that 
>>>>>> can only attach to
>>>>>> - * Sun's <i>HotSpot</i> virtual machine. In general, if an 
>>>>>> environment
>>>>>> + * Oracle's <i>HotSpot</i> virtual machine. In general, if an 
>>>>>> environment
>>>>>>    * consists of Java virtual machines of different versions and 
>>>>>> from different
>>>>>>    * vendors then there will be an attach provider implementation 
>>>>>> for each
>>>>>>    * <i>family</i> of implementations or versions.
>>>>>>    *
>>>>>>    * <p> An attach provider is identified by its {@link #name 
>>>>>> <i>name</i>} and
>>>>>>    * {@link #type <i>type</i>}. The <i>name</i> is typically, but 
>>>>>> not required to
>>>>>> - * be, a name that corresponds to the VM vendor. The Sun JDK 
>>>>>> implementation,
>>>>>> + * be, a name that corresponds to the VM vendor. The Oracle JDK 
>>>>>> implementation,
>>>>>>    * for example, ships with attach providers that use the name 
>>>>>> <i>"sun"</i>. The
>>>>>
>>>>> Perhaps clarify with
>>>>>
>>>>> that use the name <i>"sun"</i> (for historical reasons).
>>>>
>>>> Good suggestion, will update it.
>>>>
>>>> I also think about this tweak:
>>>>   that use the package name <i>"sun"</i> (for historical reasons).
>>>>
>>>> as it is used for the package name only.
>>>>
>>>>>
>>>>> ?
>>>>>
>>>>>>    * <i>type</i> typically corresponds to the attach mechanism. 
>>>>>> For example, an
>>>>>>    * implementation that uses the Doors inter-process 
>>>>>> communication mechanism
>>>>>>
>>>>>>
>>>>>> Summary:
>>>>>>    The AttachProvider spec became a little obsolete.
>>>>>>    It should not refer to Sun implementation.
>>>>>>    The fix is to replace 'Sun' with 'Oracle' in 3 places.
>>>>>>    I don't think we need a CSR for this doc change.
>>>>>
>>>>> I agree no CSR request is needed.
>>>>
>>>> Good.
>>>>
>>>> Thank you for review, David!
>>>> Serguei
>>>>
>>>>
>>>>> Thanks,
>>>>> David
>>>>>
>>>>>>
>>>>>> Thanks,
>>>>>> Serguei
>>>>
>>>

[prev in list] [next in list] [prev in thread] [next in thread]