You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@bookkeeper.apache.org by sh...@apache.org on 2022/06/03 05:23:14 UTC
[bookkeeper] branch master updated: Clean up javadoc mojos execution (#2906)
This is an automated email from the ASF dual-hosted git repository.
shoothzj pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/bookkeeper.git
The following commit(s) were added to refs/heads/master by this push:
new 5f1b000744 Clean up javadoc mojos execution (#2906)
5f1b000744 is described below
commit 5f1b00074437a632cd48d5709492a8aca6b4d540
Author: Fangbin Sun <su...@gmail.com>
AuthorDate: Fri Jun 3 13:23:06 2022 +0800
Clean up javadoc mojos execution (#2906)
Descriptions of the changes in this PR:
### Motivation
Fixes #1514.
### Changes
1. Configuring maven-javadoc-plugin with `detectOfflineLinks=false` eliminates the Maven invocations (refer to: [https://issues.redhat.com/browse/ISPN-8629](https://issues.redhat.com/browse/ISPN-8629)).
2. Use option `notimestamp` to replace `additionalparam` since the latter is not allowed from version `3.x`.
---
pom.xml | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/pom.xml b/pom.xml
index 195f3334ec..049c2003de 100644
--- a/pom.xml
+++ b/pom.xml
@@ -912,7 +912,7 @@
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven-javadoc-plugin.version}</version>
<configuration>
- <additionalparam>-notimestamp</additionalparam>
+ <notimestamp>true</notimestamp>
<!-- Prevent missing javadoc comments from being marked as errors -->
<doclint>none</doclint>
<subpackages>org.apache.bookkeeper.client:org.apache.bookkeeper.client.api:org.apache.bookkeeper.common.annotation:org.apache.bookkeeper.conf:org.apache.bookkeeper.feature:org.apache.bookkeeper.stats</subpackages>
@@ -941,6 +941,10 @@
<overview>site/_site/overview/index.html</overview>
<show>package</show>
<detectJavaApiLink>false</detectJavaApiLink>
+ <!-- The javadoc plugin only runs in the javadoc modules. But with the default configuration it tries
+ to run a new maven instance in every dependency, in order to generate the apidocs there as well.
+ {@link https://maven.apache.org/plugins-archives/maven-javadoc-plugin-3.1.1/javadoc-mojo.html#detectOfflineLinks} -->
+ <detectOfflineLinks>false</detectOfflineLinks>
</configuration>
<executions>
<execution>