Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 900856 (JBPAPP6-1587)

Summary: Update to Javadoc for EAP 6.0.1
Product: [JBoss] JBoss Enterprise Application Platform 6 Reporter: Ondřej Žižka <ozizka>
Component: DocumentationAssignee: Ondřej Žižka <ozizka>
Status: CLOSED NOTABUG QA Contact:
Severity: high Docs Contact:
Priority: high    
Version: unspecifiedCC: atangrin, jcechace, myarboro, ozizka, rsvoboda, smcgowan
Target Milestone: ---Keywords: Documentation
Target Release: TBD EAP 6, EAP 6.1.0   
Hardware: Unspecified   
OS: Unspecified   
URL: http://jira.jboss.org/jira/browse/JBPAPP6-1587
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2013-04-05 19:39:07 UTC Type: Task
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On: 900570, 900871, 900878, 900898, 901225    
Bug Blocks: 900986    
Attachments:
Description Flags
IncludesNew.txt
none
IncludesOrig.txt
none
Includes.txt
none
packagesOrig.txt
none
packages-new.txt
none
unsupportedA.txt
none
unsupportedB.txt none

Description Ondřej Žižka 2012-09-06 11:27:14 UTC
project_key: JBPAPP6

Take https://docspace.corp.redhat.com/docs/DOC-105009 into account.
_Module Classification for EAP 6 Release Notes / EAP 6.0.1 module.xml Changes_

Comment 1 Ondřej Žižka 2012-09-06 11:30:24 UTC
Link: Added: This issue is related to AS7-582


Comment 2 Ondřej Žižka 2012-09-06 11:31:59 UTC
Attaching includes - new, original, and resulting merge.

Comment 3 Ondřej Žižka 2012-09-06 11:31:59 UTC
Attachment: Added: IncludesNew.txt
Attachment: Added: IncludesOrig.txt
Attachment: Added: Includes.txt


Comment 4 Ondřej Žižka 2012-09-06 11:34:36 UTC
Attaching packages, for comparison.

Comment 5 Ondřej Žižka 2012-09-06 11:34:36 UTC
Attachment: Added: packagesOrig.txt
Attachment: Added: packages-new.txt


Comment 6 Ondřej Žižka 2012-09-06 12:26:51 UTC
Filled http://bugzilla.slf4j.org/show_bug.cgi?id=270 to fix
{quote}
unmappable character for encoding UTF-8
[ERROR] // J�rn Huxhorn: ...
{quote}

Comment 7 Ondřej Žižka 2012-09-09 20:48:54 UTC
Link: Added: This issue depends JBPAPP-9210


Comment 8 Ondřej Žižka 2012-09-10 03:41:00 UTC
{code}
~/work/AS7/ozizka-git/build$ mvn javadoc:aggregate -PjavadocDist -Djavadoc.branding='JBoss Enterprise Application Platform 6.0.1.GA'  -Dmaven.repo.local=../local-repo-eap -s ../tools/maven/conf/settings.xml
{code}

Comment 9 Ondřej Žižka 2012-09-10 04:31:25 UTC
when building the javadoc from EAP, using  ER1 tag, and a command 

       AS7/ozizka-git/build$ mvn javadoc:aggregate -PjavadocDist -Djavadoc.branding='JBoss Enterprise Application Platform 6.0.1.GA'  -Dmaven.repo.local=../local-repo-eap -s ../tools/maven/conf/settings.xml

, I get the following error:

      [ERROR] Unable to get dependency information for junit:junit:jar:4.10-redhat-1: Failed to process POM for junit:junit:jar:4.10-redhat-1: Non-resolvable parent POM for org.jboss:jboss-parent:8-redhat-1: Could not find artifact
      org.jboss.component.management:jboss-component-version-master:pom:6.0.0-redhat-1 in eap6-mirror-setting (http://download.lab.bos.redhat.com/brewroot/repos/jb-eap-6-rhel-6-build/latest/maven/)

I assume 6.0.1-redhat-1 should be used, right?
   http://download.lab.bos.redhat.com/brewroot/repos/jb-eap-6-rhel-6-build/latest/maven/org/jboss/component/management/jboss-component-version-master/

So it should use parent 9-redhat-1:
   http://download.lab.bos.redhat.com/brewroot/repos/jb-eap-6-rhel-6-build/latest/maven/org/jboss/jboss-parent/9-redhat-1/


Comment 10 Ondřej Žižka 2012-09-10 13:22:00 UTC
Link: Added: This issue depends JBPAPP-9865


Comment 11 Ondřej Žižka 2012-09-10 22:06:23 UTC
Link: Added: This issue depends JBPAPP-9877


Comment 13 Ondřej Žižka 2012-09-12 13:25:35 UTC
Apart from reclassification, we also agreed to wait for some fixes in deps' poms - see dependency jiras.
I will resume with ER2.

Comment 15 Ondřej Žižka 2012-09-19 03:04:50 UTC
Should I treat the "unsupported" flag the same as "private", i.e. not include it and it's deps in the Javadoc?

Comment 16 Ondřej Žižka 2012-09-19 03:05:28 UTC
Link: Added: This issue depends JBPAPP-9944


Comment 17 Shelly McGowan 2012-09-19 03:08:38 UTC
For JavaDoc, unsupported should be treated same as private.

Comment 18 Ondřej Žižka 2012-09-19 03:50:01 UTC
7.1.3.CR1 doesn't contain module com.googlecode.jtype, EAP ER2 does

Comment 19 Ondřej Žižka 2012-09-19 04:08:37 UTC
I'm attaching unsupported[A|B].txt for anyone who wants to compare:
A has unsupported included,
B has them not included.


Comment 20 Ondřej Žižka 2012-09-19 04:08:37 UTC
Attachment: Added: unsupportedA.txt
Attachment: Added: unsupportedB.txt


Comment 21 Ondřej Žižka 2012-09-19 04:37:01 UTC
TODO: Put to readme and push:
{code}
git reset extractPublicApiArtifactsList.sh upstream/master
git reset extractPackageGroupsByModules.sh upstream/master
{code}

Comment 23 Ondřej Žižka 2012-09-21 15:04:49 UTC
7. Number of not valid POM's and metadata files
19 of 913
https://hudson.qa.jboss.com/hudson/view/EAP6/view/EAP6-Repository/job/eap-60-repository-maven-check-valid-POM-and-Metadata-files

14. Number of BOMs with failures when receiving dependency tree on test pom file with dependency on BOM from repository
6 of 13 (with MEAD and central repo enabled)
8 of 13 (just with MEAD repo)
http://jenkins.mw.lab.eng.bos.redhat.com/hudson/view/EAP6/view/EAP6-Repository/job/eap-60-repository-maven-check-boms-for-dependency-tree

15. Number of BOMs with failures when receiving effective pom on test pom file with dependency on BOM from repository
2 of 13 (with MEAD and central repo enabled)
2 of 13 (just with MEAD repo)
http://jenkins.mw.lab.eng.bos.redhat.com/hudson/view/EAP6/view/EAP6-Repository/job/eap-60-repository-maven-check-boms-for-effective-pom


Comment 24 Ondřej Žižka 2012-09-25 18:33:25 UTC
Link: Added: This issue is related to AS7-583


Comment 25 Jakub Cechacek 2012-10-08 10:30:59 UTC
Closing this issue as it makred as resolved.

It is not meant for verification (task)

Comment 26 Ondřej Žižka 2012-10-15 21:35:29 UTC
Reopening as per JBPAPP-10099

Comment 27 Ondřej Žižka 2012-10-15 22:44:44 UTC
Notes for myself

{code}
cp -r ../ozizka-git3/build/src/main/resources/modules/ build/src/main/resources/modules/
./build/javadoc/extractPublicApiArtifactsList.sh
# Copy <includes>, check changes and exclude errorneous .jar's
./build/javadoc/extractPackageGroupsByModules.sh  > grp.txt
# Copy & check the <groups>
cd build
export JAVA_HOME=/usr/lib/jvm/jdk1.7.0_04/
mvn javadoc:aggregate -PjavadocDist -Djavadoc.branding='JBoss Enterprise Application Platform 6.0.1.GA';
{code}



Comment 28 Ondřej Žižka 2012-10-15 23:38:35 UTC
Uploaded fixed (see JBPAPP-10099) Javadoc: 
http://www.qa.jboss.com/~ozizka/AS7/javadoc/javadoc-EAP-6.0.1.ER3-master.jar
http://www.qa.jboss.com/~ozizka/AS7/javadoc/6.0.1-ER3-master/

This time, I've had problems with Netty. The group was changed from org.jboss.netty to io.netty, but still some parts have Netty in guts:
https://github.com/jbossas/jboss-as/pull/3187#issuecomment-9465445

Generated from current AS/master, using eap/master's module.xml's.

Comment 29 Ondřej Žižka 2012-10-18 06:47:02 UTC
Link: Added: This issue relates to JBPAPP-10222


Comment 30 Ondřej Žižka 2012-10-18 07:38:00 UTC
Regenerated, this time using eap/eap6 module.xml's.
(Master is just a copy of upstream/master.)

http://www.qa.jboss.com/~ozizka/AS7/javadoc/6.0.1.ER3-eap6.jar
http://www.qa.jboss.com/~ozizka/AS7/javadoc/6.0.1.ER3-eap6

Comment 32 Jakub Cechacek 2012-10-25 08:35:18 UTC
Yea, sorry for that - there are other jiras for the same issue with javadoc, so it is a little confusing.

As I commented on [JBPAPP-10099|https://issues.jboss.org/browse/JBPAPP-10099]

---------------------------
http://pastebin.test.redhat.com/112541

There may be some  confusion about org.apache.cxf.* as api is public and implementation isn't. However I've made some quick tweaks of control script so it now shouldn't list package as leaked if it is also part of some public module

Comment 33 Ondřej Žižka 2012-10-25 11:21:23 UTC
No problem. I use Jira extensively, also to track my tasks... so I may have jiras which seem to be duplicate. You can tell such apart by Reporter == Assignee == Ondrej Zizka :)
Usually, people verify and then reopen/close jiras of which they are Reporters.


Comment 34 Ondřej Žižka 2012-10-25 12:58:43 UTC
Need to update upstream...

Comment 35 Anne-Louise Tangring 2012-10-25 14:46:19 UTC
This issue is not a blocker nor a critical for EAP 6.0.1. Thus it is moved to TBD EAP 6 to be triaged for the next EAP 6.x release.

Comment 36 Ondřej Žižka 2012-10-25 18:10:48 UTC
Ok. Actually, I believe the EAP part is done, just waiting for QA to confirm.

Comment 37 Ondřej Žižka 2012-10-29 15:24:19 UTC
Link: Added: This issue is a dependency of JBPAPP-10099


Comment 38 Anne-Louise Tangring 2012-11-13 21:13:22 UTC
Docs QE Status: Removed: NEW 


Comment 39 Ondřej Žižka 2012-11-25 19:16:46 UTC
Link: Added: This issue relates to JBPAPP6-1327


Comment 40 Jakub Cechacek 2012-11-29 09:28:53 UTC
EAP part is certainly not done. There are no leaked private packages in the doc anymore, but some public packages are still missing (because they are blacklisted) - see JBPAPP6-1327. If there is a reason why those packages are missing then it should be mentioned in Module Classification document on docspace. Then it will be considered correct and we can close this issue. 



Comment 41 Jakub Cechacek 2012-11-30 09:02:19 UTC
After the update of Classification document the only issue left is com.googlecode.jtype but Ondra should be discussing this with productization - let me know about the decision. 



Comment 42 Ondřej Žižka 2012-11-30 11:30:37 UTC
Asked Brian and Jimmy Wilson to confirm that it's a public API.

Comment 43 Ondřej Žižka 2012-12-03 14:46:22 UTC
Brian confirmed com.googlecode.jtype  is not supposed to be public. See JBPAPP6-1673.

Comment 44 Ondřej Žižka 2012-12-03 14:47:07 UTC
Link: Added: This issue depends JBPAPP6-1673


Comment 45 Shelly McGowan 2013-04-05 19:39:07 UTC
JavaDoc for EAP 6.0.1.GA was provided with the release: http://download.devel.redhat.com/released/JBEAP-6/6.0.1/zip/

Considering this Done.