This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 153900 - Include java api doc into NB+JDK bundle
Summary: Include java api doc into NB+JDK bundle
Status: NEW
Alias: None
Product: installer
Classification: Unclassified
Component: JDK bundle (show other bugs)
Version: 6.x
Hardware: PC All
: P3 blocker (vote)
Assignee: Libor Fischmeistr
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-11-26 00:01 UTC by jirka_x1
Modified: 2014-02-10 14:15 UTC (History)
3 users (show)

See Also:
Issue Type: ENHANCEMENT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description jirka_x1 2008-11-26 00:01:24 UTC
It would improve the out-of-the-box experience, if the NB+jdk bundle included java api javadoc.
Comment 1 Petr Dvorak 2008-11-27 10:04:11 UTC
Read discussion in issue 76186, please and also add your vote to that issue...

*** This issue has been marked as a duplicate of 76186 ***
Comment 2 jirka_x1 2008-11-27 22:44:10 UTC
I saw issue 76186 before filing this. It is a related issue, but I don't see how it can be marked as a duplicate.

I was suggesting to add java api doc only to the NB+jdk bundle, something that can be done tomorrow. Issue 76186
discusses automatized download of javadoc. This is far more complicated to do. I would suggest reopening this issue.
Comment 3 jirka_x1 2008-12-04 15:18:12 UTC
Reopened because it is not a duplicate. See reasons in the previous comment.
Comment 4 dlipin 2008-12-04 15:33:19 UTC
OK, I reassigned Issue 76186 to the other team.
From this moment we treat this issue as the enhancement request to add javadoc to NetBeans/JDK bundle.
Comment 5 Petr Dvorak 2008-12-04 17:30:56 UTC
Sorry for the late reply - I didn't add myself on CC:(. Issue 76186 says:

> IDE usually runs on 2 major JDK releases eg. NB 5.0 runs on JDK 1.4.2 and JDK 1.5.0.
> **For NB+JDK bundle this is question for wider audience.** I cannot decide we will
> bundle additional 40MB to installer.

I wanted to keep just one issue for "cannot use API docs in NB", so that we do not have similar issues and discussion of
wider audience can be more in one place...

But OK, no problem, we can have 2 issues, one for automatic download+installation of JavaDoc, one for bundling JavaDoc
in JDK+NB bundle...
Comment 6 dlipin 2008-12-05 19:08:01 UTC
Just to note. The integration of the JDK docs into the NetBeans IDE is pretty simple.
The only thing to do is to extract the zip archive with the java api docs to the JDK directory (it creates "docs" 
directory with a bunch of files there). 
NetBeans automatically picks up that dir as the javadoc folder for the Java SE platform.

So far I see 2 concerns regarding adding java api docs to NetBeans/JDK bundle:
1) extra download size. It means extra 56MB for NB/JDK6 bundle (current size is ~130MB) and 44MB for NB/JDK5 (~105MB)
2) some legal aspects

It is also worth mentioning that for JDK5 the Japanese version of java api docs exist. 
Not sure how to handle that...
Comment 7 jirka_x1 2008-12-08 18:00:20 UTC
I don't understand the legal issues, but:

Ad Japanese version - if one downloads non-Japanese version of the IDE than English version of the javadoc would be
included. 

Ad size - I did not realize that at the current internet speeds 40MB extra would be an issue. It takes under 2s to
download 40 MB with a reasonable broadband. I just forgot that not all places have broadband.

Since the distributions are created automatically, is it a problem to create one with and one without the docs? 

But maybe the best solution would be to simply put a note on the download page saying "And BTW the bundle does not
contain javadoc which can be downloaded here; follow these steps to install it." 

It is easy to get an impression that by downloading the bundle one gets a complete thing. So when javadoc does not work
one thinks something is broken, not that something extra must be downloaded. 
Comment 8 Petr Dvorak 2008-12-09 12:09:06 UTC
I understand it, Jirka. What about following, dlipin:

NB+JDK bundle would have a custom installer with one additional step, which would allow you to download and install the
some components, for example JDK (the right version+language), Glassfish server, ... etc. Simply, the current download
size would be approximately the same and user would be able to download additional software during the install time. It
shouldn't have any serious legal issues (?), right and should not be too difficult too (?).

> It is easy to get an impression that by downloading the bundle one gets a complete thing.
> So when javadoc does not work one thinks something is broken, not that something extra must be downloaded. 

I think that pop-up window with instructions pops up in IDE when you invoke Help>Javadoc index search.
Comment 9 Jiri Rechtacek 2012-10-07 13:05:53 UTC
Assigned to new owner.