This is an automated email from the ASF dual-hosted git repository.
abukor pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kudu.git
The following commit(s) were added to refs/heads/master by this push:
new 5c19386 [docs] Add note about Javadoc compatibility
5c19386 is described below
commit 5c19386ab45430665ce3852729525499c93fb4ff
Author: Attila Bukor <[email protected]>
AuthorDate: Tue Jan 5 16:41:00 2021 +0100
[docs] Add note about Javadoc compatibility
An earlier commit (3d344ecefe) disabled building javadoc on JDK 10+ due
to some compatibility issues. When attempting to build javadoc, the
actual building will be skipped and it will fail making the docs.
If the javadoc build is re-enalbed for JDK 10+, it fails with the below
error:
javadoc: error - Class
org.apache.yetus.audience.tools.IncludePublicAnnotationsStandardDoclet is not a
valid doclet.
Note: As of JDK 13, the com.sun.javadoc API is no longer supported.
This commit adds a note about this compatibility issue to the docs
building readme to make sure people build docs on JDK 8.
Change-Id: I1a84edd44e890c37fcf857f7904b6de10948f0fb
Reviewed-on: http://gerrit.cloudera.org:8080/16924
Tested-by: Kudu Jenkins
Reviewed-by: Grant Henke <[email protected]>
---
README.adoc | 3 +++
1 file changed, 3 insertions(+)
diff --git a/README.adoc b/README.adoc
index ac6962b..55c7a8c 100644
--- a/README.adoc
+++ b/README.adoc
@@ -308,6 +308,9 @@ and Linux (e.g. file vs log block manager) and the
configuration reference is
generated by running the binaries with `-help`, the documentation *MUST NOT* be
generated on Mac for publishing purposes, only for verification.
+NOTE: Java API docs can only be built on Java 8 due to Javadoc compatibility
+issues.
+
[[updating-the-site]]
=== Updating the Kudu web site documentation
