Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FLINK-7702] Fix Javadoc build issues #5003

Merged
merged 2 commits into from
Nov 13, 2017

Conversation

aljoscha
Copy link
Contributor

This remove the genjavadoc tool which doesn't work with our code base right now and also adds a dependency in the root pom that is needed for building the Javadocs (description in the commit).

R: @twalthr

genjavadoc generated some Java code that was making Javadoc fail.
Before, we had it in places that require it. This doesn't work when
running mvn javadoc:aggregate because this will only run for the root
pom and can then not find the "bundle" dependencies.
@twalthr
Copy link
Contributor

twalthr commented Nov 13, 2017

@aljoscha I tried to build the docs on my local machine but it still fails with:

[ERROR] Error while creating javadoc report: Missing:
----------
1) org.apache.directory.jdbm:apacheds-jdbm1:bundle:2.0.0-M2

  Try downloading the file manually from the project website.

  Then, install it using the command:
      mvn install:install-file -DgroupId=org.apache.directory.jdbm -DartifactId=apacheds-jdbm1 -Dversion=2.0.0-M2 -Dpackaging=bundle -Dfile=/path/to/file

  Alternatively, if you host your own repository you can deploy the file there:
      mvn deploy:deploy-file -DgroupId=org.apache.directory.jdbm -DartifactId=apacheds-jdbm1 -Dversion=2.0.0-M2 -Dpackaging=bundle -Dfile=/path/to/file -Durl=[url] -DrepositoryId=[id]

  Path to dependency:
  	1) org.apache.flink:flink-connector-kafka-base_2.11:jar:1.5-SNAPSHOT
  	2) org.apache.hadoop:hadoop-minikdc:jar:2.7.2
  	3) org.apache.directory.server:apacheds-jdbm-partition:jar:2.0.0-M15
  	4) org.apache.directory.jdbm:apacheds-jdbm1:bundle:2.0.0-M2

----------
1 required artifact is missing.

for artifact:
  org.apache.flink:flink-connector-kafka-base_2.11:jar:1.5-SNAPSHOT

Using: mvn javadoc:aggregate -DadditionalJOption="-Xdoclint:none" -Dmaven.javadoc.failOnError=false

@aljoscha
Copy link
Contributor Author

Did you use the branch that has both commits? Not the first PR that doesn't have the maven-bundle-plugin fixes?

@aljoscha
Copy link
Contributor Author

For me it does work locally but it could be an issue that I have something in my caches that you don't have. Which would be bad because then it wouldn't work on the buildbot either.

@twalthr
Copy link
Contributor

twalthr commented Nov 13, 2017

Wait I might build the wrong branch. Let me check it again.

@twalthr
Copy link
Contributor

twalthr commented Nov 13, 2017

It worked. +1 for this.

@asfgit asfgit merged commit 2929eda into apache:master Nov 13, 2017
@aljoscha aljoscha deleted the jira-7702-fix-javadoc-build branch November 22, 2017 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants