Project

General

Profile

Bug #13315

jdk11 makes consistent javadoc generation impossible

Added by Peter Tribble 14 days ago. Updated 6 days ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
-
Start date:
Due date:
% Done:

100%

Estimated time:
Difficulty:
Medium
Tags:
Gerrit CR:

Description

While #13083 enabled builds using jdk11, if jdk11 is updated to the latest release the build fails:

==== package build errors (non-DEBUG) ====

dmake: Warning: Command failed for target `packages.i386/developer-dtrace.pub'
dmake: Warning: Target `install' not remade because of errors

==== Validating manifests against proto area ====

Entries present in manifests but not proto area:
file NOHASH group=other mode=0644 owner=root path=usr/share/lib/java/javadoc/dtrace/api/jquery/jquery-3.3.1.js
file NOHASH group=other mode=0644 owner=root path=usr/share/lib/java/javadoc/dtrace/api/jquery/jquery-migrate-3.0.1.js

Entries present in proto area but not manifests:
file usr/share/lib/java/javadoc/dtrace/api/jquery/jquery-3.5.1.js group=group mode=0644 owner=owner path=usr/share/lib/java/javadoc/dtrace/api/jquery/jquery-3.5.1.js

Fundamentally, the generated javadoc (i's only libdtrace_jni, the other javadoc in the gate has already been dropped) is liable to change between java updates in essentially arbitrary fashion.

Rather than attempt to track every single update, it seems cleaner to not build or package javadoc. Rather, we could generate the javadoc output out of band and make it available online where it can be accessed from anywhere.

I've generated the javadoc for the code we have and put a copy here temporarily for examination:

https://pkgs.tribblix.org/javadoc/

Removing javadoc from the build makes ongoing maintenance much easier, as handling the javadoc was a large part of the effort involved in adding support for newer java versions.

#1

Updated by Electric Monk 14 days ago

  • Gerrit CR set to 1063
#2

Updated by Peter Tribble 8 days ago

Testing: Build and packaging are clean when built with both java 8 and 11. Checked (by reviewing nightly.log) that javadoc isn't run, and that nothing unexpected ends up in the proto area.

#3

Updated by Electric Monk 6 days ago

  • Status changed from New to Closed
  • % Done changed from 0 to 100

git commit 273d774d1d685415fd99d31224bdae55e7cfb793

commit  273d774d1d685415fd99d31224bdae55e7cfb793
Author: Peter Tribble <peter.tribble@gmail.com>
Date:   2020-11-23T19:25:04.000Z

    13315 jdk11 makes consistent javadoc generation impossible
    Reviewed by: Andy Fiddaman <andy@omniosce.org>
    Reviewed by: Toomas Soome <tsoome@me.com>
    Approved by: Robert Mustacchi <rm@fingolfin.org>

Also available in: Atom PDF