You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@bookkeeper.apache.org by GitBox <gi...@apache.org> on 2022/06/06 12:48:09 UTC
[GitHub] [bookkeeper] Shoothzj opened a new pull request, #3317: Fix maven javadoc generate
Shoothzj opened a new pull request, #3317:
URL: https://github.com/apache/bookkeeper/pull/3317
### Motivation
Currently, the maven javadoc generate is broken both on master and branch-4.14
### Changes
- fix the javadoc generate
- delete unneeded `package-info` file
- delete unused dependency `spotbugs-annotations`, it's not worth to open other pr(IMO)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] eolivelli commented on a diff in pull request #3317: Fix maven javadoc generate
Posted by GitBox <gi...@apache.org>.
eolivelli commented on code in PR #3317:
URL: https://github.com/apache/bookkeeper/pull/3317#discussion_r891007190
##########
pom.xml:
##########
@@ -110,6 +110,7 @@
<javac.target>1.8</javac.target>
<redirectTestOutputToFile>true</redirectTestOutputToFile>
<testRetryCount>2</testRetryCount>
+ <src.dir>src/main/java</src.dir>
Review Comment:
if this is only for "delombok" then what about giving a more specific name ? like output.delombok.dir ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] Shoothzj commented on pull request #3317: Fix maven javadoc generate
Posted by GitBox <gi...@apache.org>.
Shoothzj commented on PR #3317:
URL: https://github.com/apache/bookkeeper/pull/3317#issuecomment-1304702450
@hangc0276 I am on vacation now. @xiang092689 He volunteered to help with this.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] Shoothzj commented on a diff in pull request #3317: Fix maven javadoc generate
Posted by GitBox <gi...@apache.org>.
Shoothzj commented on code in PR #3317:
URL: https://github.com/apache/bookkeeper/pull/3317#discussion_r891008935
##########
pom.xml:
##########
@@ -110,6 +110,7 @@
<javac.target>1.8</javac.target>
<redirectTestOutputToFile>true</redirectTestOutputToFile>
<testRetryCount>2</testRetryCount>
+ <src.dir>src/main/java</src.dir>
Review Comment:
it's also used by javadoc maven plugin.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] Shoothzj commented on pull request #3317: Fix maven javadoc generate
Posted by GitBox <gi...@apache.org>.
Shoothzj commented on PR #3317:
URL: https://github.com/apache/bookkeeper/pull/3317#issuecomment-1147607153
rerun failure checks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] Shoothzj commented on pull request #3317: Fix maven javadoc generate
Posted by GitBox <gi...@apache.org>.
Shoothzj commented on PR #3317:
URL: https://github.com/apache/bookkeeper/pull/3317#issuecomment-1147558685
rerun failure checks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] Shoothzj commented on pull request #3317: Fix maven javadoc generate
Posted by GitBox <gi...@apache.org>.
Shoothzj commented on PR #3317:
URL: https://github.com/apache/bookkeeper/pull/3317#issuecomment-1147558867
@dlg99 @eolivelli @nicoloboschi PTAL
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] hangc0276 commented on pull request #3317: Fix maven javadoc generate
Posted by GitBox <gi...@apache.org>.
hangc0276 commented on PR #3317:
URL: https://github.com/apache/bookkeeper/pull/3317#issuecomment-1304550935
@Shoothzj This Pr has too many conflicts with branch-4.14, would you please push a separate PR to branch-4.14?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] Shoothzj commented on pull request #3317: Fix maven javadoc generate
Posted by GitBox <gi...@apache.org>.
Shoothzj commented on PR #3317:
URL: https://github.com/apache/bookkeeper/pull/3317#issuecomment-1148357848
@dlg99 @eolivelli @nicoloboschi PTAL
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] Shoothzj commented on pull request #3317: Fix maven javadoc generate
Posted by GitBox <gi...@apache.org>.
Shoothzj commented on PR #3317:
URL: https://github.com/apache/bookkeeper/pull/3317#issuecomment-1148421587
@nicoloboschi we can remove the colon of `bookkeeper-common` and `bookkeeper-server`. We need colon for non-top-level modules. I have pushed a fix.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] Shoothzj commented on pull request #3317: Fix maven javadoc generate
Posted by GitBox <gi...@apache.org>.
Shoothzj commented on PR #3317:
URL: https://github.com/apache/bookkeeper/pull/3317#issuecomment-1147422082
The javadoc is generated fine.
<img width="1230" alt="image" src="https://user-images.githubusercontent.com/12933197/172165928-45618a5d-2dda-4be9-93a3-86ae3e99f57f.png">
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] Shoothzj commented on a diff in pull request #3317: Fix maven javadoc generate
Posted by GitBox <gi...@apache.org>.
Shoothzj commented on code in PR #3317:
URL: https://github.com/apache/bookkeeper/pull/3317#discussion_r890987456
##########
stream/distributedlog/pom.xml:
##########
@@ -47,8 +47,9 @@
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven-javadoc-plugin.version}</version>
<configuration>
+ <sourcepath>${src.dir}</sourcepath>
+ <notimestamp>true</notimestamp>
<!-- Avoid for missing javadoc comments to be marked as errors -->
Review Comment:
@nicoloboschi why? it's commented for `<doclint>none<doclint>`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] nicoloboschi commented on a diff in pull request #3317: Fix maven javadoc generate
Posted by GitBox <gi...@apache.org>.
nicoloboschi commented on code in PR #3317:
URL: https://github.com/apache/bookkeeper/pull/3317#discussion_r890979011
##########
.github/workflows/pr-validation.yml:
##########
@@ -56,6 +56,5 @@ jobs:
- name: Check license files
run: dev/check-all-licenses
- # keeping on gradle, `mvn site javadoc:javadoc`, to figure out later
- name: Generate Javadoc
- run: ./gradlew generateApiJavadoc
+ run: mvn clean -B -nsu -am -pl :bookkeeper-common,:bookkeeper-server,:bookkeeper-stats-api,:bookkeeper-stats-providers,:codahale-metrics-provider,:prometheus-metrics-provider install javadoc:aggregate -DskipTests -Pdelombok
Review Comment:
the Maven standard syntax for `-pl` does not require the colon, I'd prefer to remove them
##########
stream/distributedlog/pom.xml:
##########
@@ -47,8 +47,9 @@
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven-javadoc-plugin.version}</version>
<configuration>
+ <sourcepath>${src.dir}</sourcepath>
+ <notimestamp>true</notimestamp>
<!-- Avoid for missing javadoc comments to be marked as errors -->
Review Comment:
no longer useful comment
##########
site3/website/scripts/javadoc-gen.sh:
##########
@@ -34,7 +34,7 @@ function build_javadoc() {
if [[ "$use_gradle" == "true" ]]; then
./gradlew generateApiJavadoc
else
- mvn clean install javadoc:aggregate -DskipTests
+ mvn clean -B -nsu -am -pl :bookkeeper-common,:bookkeeper-server,:bookkeeper-stats-api,:bookkeeper-stats-providers,:codahale-metrics-provider,:prometheus-metrics-provider install javadoc:aggregate -DskipTests -Pdelombok
Review Comment:
the Maven standard syntax for -pl does not require the colon, I'd prefer to remove them
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] Shoothzj merged pull request #3317: Fix maven javadoc generate
Posted by GitBox <gi...@apache.org>.
Shoothzj merged PR #3317:
URL: https://github.com/apache/bookkeeper/pull/3317
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org