[jira] [Commented] (DERBY-7028) Module diagrams missing from javadoc for 15.1.0.0 release candidate
[ https://issues.apache.org/jira/browse/DERBY-7028?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16760957#comment-16760957 ] ASF subversion and git services commented on DERBY-7028: Commit 1853014 from Richard N. Hillegas in branch 'code/branches/10.15' [ https://svn.apache.org/r1853014 ] DERBY-7028: Port 1851720 from trunk to the 10.15 branch. > Module diagrams missing from javadoc for 15.1.0.0 release candidate > --- > > Key: DERBY-7028 > URL: https://issues.apache.org/jira/browse/DERBY-7028 > Project: Derby > Issue Type: Bug > Components: Build tools >Affects Versions: 10.15.1.2 >Reporter: Rick Hillegas >Assignee: Rick Hillegas >Priority: Major > Fix For: 10.15.1.2 > > Attachments: derby-7028-01-aa-jdkSpecificImageLocations.diff, > derby-7028-02-aa-html5borders.diff > > > This must be fixed for the release. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (DERBY-7028) Module diagrams missing from javadoc for 15.1.0.0 release candidate
[ https://issues.apache.org/jira/browse/DERBY-7028?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16760952#comment-16760952 ] ASF subversion and git services commented on DERBY-7028: Commit 1853012 from Richard N. Hillegas in branch 'code/branches/10.15' [ https://svn.apache.org/r1853012 ] DERBY-7028: Merge 1851719 from trunk to 10.15 branch. > Module diagrams missing from javadoc for 15.1.0.0 release candidate > --- > > Key: DERBY-7028 > URL: https://issues.apache.org/jira/browse/DERBY-7028 > Project: Derby > Issue Type: Bug > Components: Build tools >Affects Versions: 10.15.1.2 >Reporter: Rick Hillegas >Assignee: Rick Hillegas >Priority: Major > Fix For: 10.15.1.2 > > Attachments: derby-7028-01-aa-jdkSpecificImageLocations.diff, > derby-7028-02-aa-html5borders.diff > > > This must be fixed for the release. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (DERBY-7028) Module diagrams missing from javadoc for 15.1.0.0 release candidate
[ https://issues.apache.org/jira/browse/DERBY-7028?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16760917#comment-16760917 ] Rick Hillegas commented on DERBY-7028: -- Sigh. This work was not ported to 10.15. > Module diagrams missing from javadoc for 15.1.0.0 release candidate > --- > > Key: DERBY-7028 > URL: https://issues.apache.org/jira/browse/DERBY-7028 > Project: Derby > Issue Type: Bug > Components: Build tools >Affects Versions: 10.15.1.2 >Reporter: Rick Hillegas >Assignee: Rick Hillegas >Priority: Major > Fix For: 10.15.1.2 > > Attachments: derby-7028-01-aa-jdkSpecificImageLocations.diff, > derby-7028-02-aa-html5borders.diff > > > This must be fixed for the release. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (DERBY-7028) Module diagrams missing from javadoc for 15.1.0.0 release candidate
[ https://issues.apache.org/jira/browse/DERBY-7028?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16747627#comment-16747627 ] Bryan Pendleton commented on DERBY-7028: Yes, that makes sense, and sounds like a good plan. Thanks for filling in the details. > Module diagrams missing from javadoc for 15.1.0.0 release candidate > --- > > Key: DERBY-7028 > URL: https://issues.apache.org/jira/browse/DERBY-7028 > Project: Derby > Issue Type: Bug > Components: Build tools >Affects Versions: 10.15.1.0 >Reporter: Rick Hillegas >Assignee: Rick Hillegas >Priority: Major > Attachments: derby-7028-01-aa-jdkSpecificImageLocations.diff, > derby-7028-02-aa-html5borders.diff > > > This must be fixed for the release. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (DERBY-7028) Module diagrams missing from javadoc for 15.1.0.0 release candidate
[ https://issues.apache.org/jira/browse/DERBY-7028?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16747591#comment-16747591 ] ASF subversion and git services commented on DERBY-7028: Commit 1851720 from Richard N. Hillegas in branch 'code/trunk' [ https://svn.apache.org/r1851720 ] DERBY-7028: Add borders to module diagrams in an html5-compliant way; commit derby-7028-02-aa-html5borders.diff. > Module diagrams missing from javadoc for 15.1.0.0 release candidate > --- > > Key: DERBY-7028 > URL: https://issues.apache.org/jira/browse/DERBY-7028 > Project: Derby > Issue Type: Bug > Components: Build tools >Affects Versions: 10.15.1.0 >Reporter: Rick Hillegas >Assignee: Rick Hillegas >Priority: Major > Attachments: derby-7028-01-aa-jdkSpecificImageLocations.diff, > derby-7028-02-aa-html5borders.diff > > > This must be fixed for the release. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (DERBY-7028) Module diagrams missing from javadoc for 15.1.0.0 release candidate
[
https://issues.apache.org/jira/browse/DERBY-7028?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16747590#comment-16747590
]
Rick Hillegas commented on DERBY-7028:
--
Attaching derby-7028-02-aa-html5borders.diff. This patch replaces border
attributes with style attributes. This applies to the elements which
locate module diagrams for module overview pages. I believe that this is the
html5 way to add borders.
Touches the following files:
{noformat}
M java/org.apache.derby.client/module-info.java
M java/org.apache.derby.commons/module-info.java
M java/org.apache.derby.engine/module-info.java
M java/org.apache.derby.optionaltools/module-info.java
M java/org.apache.derby.runner/module-info.java
M java/org.apache.derby.server/module-info.java
M java/org.apache.derby.tests/module-info.java
M java/org.apache.derby.tools/module-info.java
{noformat}
> Module diagrams missing from javadoc for 15.1.0.0 release candidate
> ---
>
> Key: DERBY-7028
> URL: https://issues.apache.org/jira/browse/DERBY-7028
> Project: Derby
> Issue Type: Bug
> Components: Build tools
>Affects Versions: 10.15.1.0
>Reporter: Rick Hillegas
>Assignee: Rick Hillegas
>Priority: Major
> Attachments: derby-7028-01-aa-jdkSpecificImageLocations.diff,
> derby-7028-02-aa-html5borders.diff
>
>
> This must be fixed for the release.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (DERBY-7028) Module diagrams missing from javadoc for 15.1.0.0 release candidate
[ https://issues.apache.org/jira/browse/DERBY-7028?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16747585#comment-16747585 ] ASF subversion and git services commented on DERBY-7028: Commit 1851719 from Richard N. Hillegas in branch 'code/trunk' [ https://svn.apache.org/r1851719 ] DERBY-7028: Put module diagrams in different directories, depending on whether the javadoc is being built by JDK 11 or pre JDK 11; commit derby-7028-01-aa-jdkSpecificImageLocations.diff. > Module diagrams missing from javadoc for 15.1.0.0 release candidate > --- > > Key: DERBY-7028 > URL: https://issues.apache.org/jira/browse/DERBY-7028 > Project: Derby > Issue Type: Bug > Components: Build tools >Affects Versions: 10.15.1.0 >Reporter: Rick Hillegas >Assignee: Rick Hillegas >Priority: Major > Attachments: derby-7028-01-aa-jdkSpecificImageLocations.diff > > > This must be fixed for the release. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (DERBY-7028) Module diagrams missing from javadoc for 15.1.0.0 release candidate
[ https://issues.apache.org/jira/browse/DERBY-7028?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16747555#comment-16747555 ] Rick Hillegas commented on DERBY-7028: -- Hey Bryan, Sorry for the confusion. If you build the public javadoc with JDK 9 or 10, then there will be one copy of each of the module diagrams. All of them will be located in the top level directory of the javadoc, next to index.html. Coincidentally, that is the same directory where the module overview pages are written. If you build the public javadoc with JDK 11, then there will also be one copy of each of the module diagrams. But each of them will be in a separate subdirectory. The engine diagram will be in the org.apache.derby.engine subdirectory of the javadoc output, next to the overview page for that module. And similarly for the other modules. There will be only one release. It will be compiled by Open JDK 11 with source and target levels both set to level 9 so that Java 9 byte code is produced. The public api javadoc will have the directory structure created by JDK 11's javadoc tool. That structure differs from the structure of our Jenkins-built javadoc for the trunk. The Jenkins build uses JDK 9. Does that make sense? Thanks. > Module diagrams missing from javadoc for 15.1.0.0 release candidate > --- > > Key: DERBY-7028 > URL: https://issues.apache.org/jira/browse/DERBY-7028 > Project: Derby > Issue Type: Bug > Components: Build tools >Affects Versions: 10.15.1.0 >Reporter: Rick Hillegas >Assignee: Rick Hillegas >Priority: Major > Attachments: derby-7028-01-aa-jdkSpecificImageLocations.diff > > > This must be fixed for the release. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (DERBY-7028) Module diagrams missing from javadoc for 15.1.0.0 release candidate
[
https://issues.apache.org/jira/browse/DERBY-7028?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16747308#comment-16747308
]
Rick Hillegas commented on DERBY-7028:
--
Attaching derby-7028-01-aa-jdkSpecificImageLocations.diff. This patch makes the
javadoc targets copy the module diagrams to different locations, depending on
the JDK being used.
The experts told me that there was no good way to write a module descriptor
whose diagram would be found regardless of which JDK was used to build the
javadoc. So I have done the following:
* Adjusted the module descriptors to locate their diagrams in the same
directory as the module descriptor's javadoc.
* Added some conditional logic to the javadoc targets to make them copy the
module diagrams to the correct directories, depending on which JDK is used to
build the javadoc.
I will attach a follow-on version of this patch in order to fix another
problem. The experts also said that the border attribute in the tags is
not supported by HTML 5 and that a future version of Java would require strict
HTML 5. I need to figure out how to put borders around the module diagrams in
an HTML5-compatible way.
Touches the following files:
{noformat}
---
M build.xml
Conditional logic to copy module diagrams to the correct directories.
---
M java/org.apache.derby.client/module-info.java
M java/org.apache.derby.commons/module-info.java
M java/org.apache.derby.engine/module-info.java
M java/org.apache.derby.optionaltools/module-info.java
M java/org.apache.derby.runner/module-info.java
M java/org.apache.derby.server/module-info.java
M java/org.apache.derby.tests/module-info.java
M java/org.apache.derby.tools/module-info.java
Adjust where the module overviews expect to find their module diagrams.
{noformat}
> Module diagrams missing from javadoc for 15.1.0.0 release candidate
> ---
>
> Key: DERBY-7028
> URL: https://issues.apache.org/jira/browse/DERBY-7028
> Project: Derby
> Issue Type: Bug
> Components: Build tools
>Affects Versions: 10.15.1.0
>Reporter: Rick Hillegas
>Assignee: Rick Hillegas
>Priority: Major
> Attachments: derby-7028-01-aa-jdkSpecificImageLocations.diff
>
>
> This must be fixed for the release.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (DERBY-7028) Module diagrams missing from javadoc for 15.1.0.0 release candidate
[ https://issues.apache.org/jira/browse/DERBY-7028?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16747312#comment-16747312 ] Bryan Pendleton commented on DERBY-7028: I'm not totally sure I understand your plan. We'll package and distribute a single release, with multiple copies of the module diagrams, one for Java 9 and one for Java 11? And the javadoc on the website will also have multiple copies of the diagrams? Or, we'll package and distribute a single release, with a single copy of the module diagrams, but it will be version Java XX? Or, we'll package and distribute multiple releases, one for Java 9 and one for Java 11? Or I'm just not understanding this issue at all? > Module diagrams missing from javadoc for 15.1.0.0 release candidate > --- > > Key: DERBY-7028 > URL: https://issues.apache.org/jira/browse/DERBY-7028 > Project: Derby > Issue Type: Bug > Components: Build tools >Affects Versions: 10.15.1.0 >Reporter: Rick Hillegas >Assignee: Rick Hillegas >Priority: Major > Attachments: derby-7028-01-aa-jdkSpecificImageLocations.diff > > > This must be fixed for the release. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (DERBY-7028) Module diagrams missing from javadoc for 15.1.0.0 release candidate
[ https://issues.apache.org/jira/browse/DERBY-7028?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16747198#comment-16747198 ] Bryan Pendleton commented on DERBY-7028: Gack! I'm still having trouble learning about Java 9 ! :) > Module diagrams missing from javadoc for 15.1.0.0 release candidate > --- > > Key: DERBY-7028 > URL: https://issues.apache.org/jira/browse/DERBY-7028 > Project: Derby > Issue Type: Bug > Components: Build tools >Affects Versions: 10.15.1.0 >Reporter: Rick Hillegas >Assignee: Rick Hillegas >Priority: Major > > This must be fixed for the release. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (DERBY-7028) Module diagrams missing from javadoc for 15.1.0.0 release candidate
[ https://issues.apache.org/jira/browse/DERBY-7028?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16747189#comment-16747189 ] Rick Hillegas commented on DERBY-7028: -- Javadoc generated by JDK 10 looks good. It is Java 11 which introduced this new directory structure. > Module diagrams missing from javadoc for 15.1.0.0 release candidate > --- > > Key: DERBY-7028 > URL: https://issues.apache.org/jira/browse/DERBY-7028 > Project: Derby > Issue Type: Bug > Components: Build tools >Affects Versions: 10.15.1.0 >Reporter: Rick Hillegas >Assignee: Rick Hillegas >Priority: Major > > This must be fixed for the release. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (DERBY-7028) Module diagrams missing from javadoc for 15.1.0.0 release candidate
[ https://issues.apache.org/jira/browse/DERBY-7028?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16741338#comment-16741338 ] Rick Hillegas commented on DERBY-7028: -- The problem appears to be that Java 11 generates the javadoc into a different structure than Java 9. The module diagrams are included by tags whose src attributes are relative file names. The location of the generated html has changed and now the relative paths point nowhere. The trunk public api on the Derby website is built by Java 9 and so it looks good. However, the javadoc in the 10.15 distributions was built by Java 11, hiding the module diagrams. I will ask the experts for advice about whether there is a best practice for handling this problem. > Module diagrams missing from javadoc for 15.1.0.0 release candidate > --- > > Key: DERBY-7028 > URL: https://issues.apache.org/jira/browse/DERBY-7028 > Project: Derby > Issue Type: Bug > Components: Build tools >Affects Versions: 10.15.1.0 >Reporter: Rick Hillegas >Assignee: Rick Hillegas >Priority: Major > > This must be fixed for the release. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
