docs requires hotspot?

Kelly O'Hair kelly.ohair at oracle.com
Fri Dec 21 11:06:33 PST 2012


I understand your annoyance, and am glad to hear of javadoc improvements, but you need to keep in
mind that the current doc generation has been rigged and hacked on for many years, by many people.
And unfortunately, as in many cases with build work, often the goal is "just get it working".

Now if we could teach our managers that "just get it working"==technical debt. :^(

-kto

On Dec 21, 2012, at 7:35 AM, Jonathan Gibbons wrote:

> It has always been annoying that the docs build happens at the end of the build, and is sufficiently slow that most people don't run it and ignore the few warnings messages that get generated.  The new doclint tool has found over 10,000 issues in the API comments, and we will need to address these, so we can expect to see more people taking the javadoc comments seriously.  In addition, after years of neglect, the javadoc tool itself is getting some TLC, at least in part to address the performance issues that make people not want to run it. So again, it will be convenient to create the docs separately from doing all the work to build images.
> 
> I'm not looking for super fine grain dependencies between components, but it would at least be nice to finer grain than "repo", perhaps down to the level of "generated source", such that important high level targets like docs get to leverage these intermediate targets.
> 
> -- Jon
> 
> 
> On 12/21/2012 11:33 AM, Erik Joelsson wrote:
>> This is a rather new usecase, at least for me, so we haven't had time to address it yet. If it's important, we will of course address it at some point. What I meant below was just that, is this feature important enough?
>> 
>> On the technical side. So far we haven't done a lot of fine granular dependencies between repos, but have instead seen a repo as a unit. The jdk is an exception since we have separate targets for demos and images. I could imagine this type of separation in hotspot too, when we do attack the hotspot make files. We haven't attacked them yet, as it's not part of this project. I sure hope to get to do it at some point.
>> 
>> /Erik
>> 
>> On 2012-12-21 12:00, Jonathan Gibbons wrote:
>>> If we haven't got better dependency management out of build-infra then it's all been a waste of time.
>>> 
>>> OK, maybe that's a bit strong, but it is really bizarre to hear about "extra complexity" to not build all of hotspot when just trying to build the docs.
>>> 
>>> -- Jon
>>> 
>>> On 12/21/2012 02:49 AM, Kelly O'Hair wrote:
>>>> The hotspot repo also contributes to the total docs (jvmti, maybe more?), so technically, even hotspot needs to be
>>>> run to create all the docs.
>>>> It's possible the jvmti doc isn't needed for the jdk api javadocs, but at least the jdi javadocs will refer to jvmti I think.
>>>> 
>>>> So this is a slippery slope, be careful.
>>>> 
>>>> -kto
>>>> 
>>>> On Dec 11, 2012, at 2:44 AM, Erik Joelsson wrote:
>>>> 
>>>>> I was a bit quick to reply here. Docs are dependent on jdk, for generated classes at least, and jdk is dependent on hotspot. Could these dependencies be more fine granular, yes, but the question is if it's worth the extra complexity.
>>>>> 
>>>>> /Erik
>>>>> 
>>>>> On 2012-12-11 10:29, Erik Joelsson wrote:
>>>>>> Good point. Should fix those dependencies. Filed 8004844.
>>>>>> 
>>>>>> On 2012-12-11 03:29, Jonathan Gibbons wrote:
>>>>>>> If I build the docs target in an otherwise clean environment, the build still wades through compiling hotspot. Is this really necessary and/or to be expected?
>>>>>>> 
>>>>>>> Don't we use interim-javadoc running on the BOOT_JAVA to build docs?
>>>>>>> 
>>>>>>> -- Jon
>>> 
> 




More information about the build-infra-dev mailing list