RFR:JDK-8190875:modules not listed in overview/index page

Priya Lakshmi Muthuswamy priya.lakshmi.muthuswamy at oracle.com
Tue Jun 5 06:44:11 UTC 2018


Hi Jon,

Thanks for the review.
I could have avoided having explicit side-file.
updated webrev : http://cr.openjdk.java.net/~pmuthuswamy/8190875/webrev.02/

Thanks,
Priya

On 6/5/2018 3:51 AM, Jonathan Gibbons wrote:
> It seems weird to have a hybrid methodology, such that you have an 
> explicit side-file (overview.html) but you generate other (source) 
> files on the fly.
>
> If you want to keep overview.html as a separate distinct file, it 
> needs to have a full legal header. Yes, I know it is sorta-silly to 
> have a 22 line legal header for a 6 line file, but that's the general 
> rule/guideline, and is also the reason why these days we prefer to 
> generate those files on the fly.
>
> You've already got an instance of ToolBox in each of the test cases, 
> but you only need overview.html in one: testIndexWithOverviewPath
>
> I recommend using ToolBox.writeFile to create the overview.html file, 
> so that the test becomes self-contained with no need for the side-file.
>
> (Side-files are OK if they start getting big and complicated, but 
> don't ask me for a hard and fast rule of when to use an inline string, 
> and when to use a side file. But generally, if the file is "small", 
> generate the file on the fly.)
>
> -- Jon
>
> On 06/03/2018 09:07 PM, Priya Lakshmi Muthuswamy wrote:
>> Hi Jon,
>>
>> I have updated the webrev with the suggestions.
>>
>> webrev : http://cr.openjdk.java.net/~pmuthuswamy/8190875/webrev.01/
>>
>> Thanks,
>> Priya
>>
>> On 6/2/2018 1:28 AM, Jonathan Gibbons wrote:
>>>
>>>
>>> On 06/01/2018 02:34 AM, Priya Lakshmi Muthuswamy wrote:
>>>> Hi,
>>>>
>>>> Kindly review the fix for 
>>>> https://bugs.openjdk.java.net/browse/JDK-8190875
>>>> webrev : http://cr.openjdk.java.net/~pmuthuswamy/8190875/webrev.00/
>>>>
>>>> Thanks,
>>>> Priya
>>>
>>> You are using a single shared src directory, and mutating it in the 
>>> various test cases.
>>> This means that the test cases are not independent, and depend on 
>>> the (unspecified)
>>> order of execution of the test cases.
>>>
>>> You should create a new copy of the "src" directory as a new 
>>> subdirectory of the "base"
>>> directory in each test case.
>>>
>>> -- Jon
>>
>



More information about the javadoc-dev mailing list