You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-issues@hadoop.apache.org by "snmvaughan (via GitHub)" <gi...@apache.org> on 2023/02/03 02:19:12 UTC
[GitHub] [hadoop] snmvaughan opened a new pull request, #5344: HADOOP-18616. Java 11 JavaDoc fails due to missing package comments
snmvaughan opened a new pull request, #5344:
URL: https://github.com/apache/hadoop/pull/5344
### Description of PR
Add JavaDoc comments to package-info.java to avoid errors resulting from the use of Hadoop annotations.
### How was this patch tested?
Running JavaDoc using Java 11 in an Hadoop development environment docker image.
```
mvn -Ptest-patch -Pdocs -DskipTests clean process-sources javadoc:javadoc-no-fork -DskipTests=true
```
These changes eliminate the JavaDoc errors.
### For code changes:
- [X] Does the title or this PR starts with the corresponding JIRA issue id (e.g. 'HADOOP-17799. Your PR title ...')?
- [ ] Object storage: have the integration tests been executed and the endpoint declared according to the connector-specific documentation?
- [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] If applicable, have you updated the `LICENSE`, `LICENSE-binary`, `NOTICE-binary` files?
--
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: common-issues-unsubscribe@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org
[GitHub] [hadoop] hadoop-yetus commented on pull request #5344: HADOOP-18616. Java 11 JavaDoc fails due to missing package comments
Posted by "hadoop-yetus (via GitHub)" <gi...@apache.org>.
hadoop-yetus commented on PR #5344:
URL: https://github.com/apache/hadoop/pull/5344#issuecomment-1415091485
:broken_heart: **-1 overall**
| Vote | Subsystem | Runtime | Logfile | Comment |
|:----:|----------:|--------:|:--------:|:-------:|
| +0 :ok: | reexec | 1m 28s | | Docker mode activated. |
|||| _ Prechecks _ |
| +1 :green_heart: | dupname | 0m 0s | | No case conflicting files found. |
| +0 :ok: | codespell | 0m 0s | | codespell was not available. |
| +0 :ok: | detsecrets | 0m 0s | | detect-secrets was not available. |
| +1 :green_heart: | @author | 0m 0s | | The patch does not contain any @author tags. |
| -1 :x: | test4tests | 0m 0s | | The patch doesn't appear to include any new or modified tests. Please justify why no new tests are needed for this patch. Also please list what manual steps were performed to verify this patch. |
|||| _ trunk Compile Tests _ |
| +1 :green_heart: | mvninstall | 46m 25s | | trunk passed |
| +1 :green_heart: | compile | 25m 29s | | trunk passed with JDK Ubuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04 |
| +1 :green_heart: | compile | 22m 3s | | trunk passed with JDK Private Build-1.8.0_352-8u352-ga-1~20.04-b08 |
| +1 :green_heart: | checkstyle | 1m 8s | | trunk passed |
| +1 :green_heart: | mvnsite | 1m 44s | | trunk passed |
| -1 :x: | javadoc | 1m 8s | [/branch-javadoc-hadoop-common-project_hadoop-common-jdkUbuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04.txt](https://ci-hadoop.apache.org/job/hadoop-multibranch/job/PR-5344/1/artifact/out/branch-javadoc-hadoop-common-project_hadoop-common-jdkUbuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04.txt) | hadoop-common in trunk failed with JDK Ubuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04. |
| +1 :green_heart: | javadoc | 0m 42s | | trunk passed with JDK Private Build-1.8.0_352-8u352-ga-1~20.04-b08 |
| +1 :green_heart: | spotbugs | 2m 46s | | trunk passed |
| +1 :green_heart: | shadedclient | 28m 23s | | branch has no errors when building and testing our client artifacts. |
|||| _ Patch Compile Tests _ |
| +1 :green_heart: | mvninstall | 1m 16s | | the patch passed |
| +1 :green_heart: | compile | 24m 46s | | the patch passed with JDK Ubuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04 |
| +1 :green_heart: | javac | 24m 46s | | the patch passed |
| +1 :green_heart: | compile | 21m 57s | | the patch passed with JDK Private Build-1.8.0_352-8u352-ga-1~20.04-b08 |
| +1 :green_heart: | javac | 21m 57s | | the patch passed |
| +1 :green_heart: | blanks | 0m 0s | | The patch has no blanks issues. |
| +1 :green_heart: | checkstyle | 1m 0s | | hadoop-common-project/hadoop-common: The patch generated 0 new + 0 unchanged - 15 fixed = 0 total (was 15) |
| +1 :green_heart: | mvnsite | 1m 40s | | the patch passed |
| +1 :green_heart: | javadoc | 1m 0s | | hadoop-common-project_hadoop-common-jdkUbuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04 with JDK Ubuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04 generated 0 new + 0 unchanged - 29 fixed = 0 total (was 29) |
| +1 :green_heart: | javadoc | 0m 41s | | the patch passed with JDK Private Build-1.8.0_352-8u352-ga-1~20.04-b08 |
| +1 :green_heart: | spotbugs | 2m 45s | | the patch passed |
| +1 :green_heart: | shadedclient | 28m 19s | | patch has no errors when building and testing our client artifacts. |
|||| _ Other Tests _ |
| +1 :green_heart: | unit | 19m 15s | | hadoop-common in the patch passed. |
| +1 :green_heart: | asflicense | 0m 54s | | The patch does not generate ASF License warnings. |
| | | 234m 45s | | |
| Subsystem | Report/Notes |
|----------:|:-------------|
| Docker | ClientAPI=1.42 ServerAPI=1.42 base: https://ci-hadoop.apache.org/job/hadoop-multibranch/job/PR-5344/1/artifact/out/Dockerfile |
| GITHUB PR | https://github.com/apache/hadoop/pull/5344 |
| Optional Tests | dupname asflicense compile javac javadoc mvninstall mvnsite unit shadedclient spotbugs checkstyle codespell detsecrets |
| uname | Linux 0d99b933cb0a 4.15.0-200-generic #211-Ubuntu SMP Thu Nov 24 18:16:04 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux |
| Build tool | maven |
| Personality | dev-support/bin/hadoop.sh |
| git revision | trunk / c40d97652cb7b0a22bc6072bd45efe0f0a2deb6b |
| Default Java | Private Build-1.8.0_352-8u352-ga-1~20.04-b08 |
| Multi-JDK versions | /usr/lib/jvm/java-11-openjdk-amd64:Ubuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04 /usr/lib/jvm/java-8-openjdk-amd64:Private Build-1.8.0_352-8u352-ga-1~20.04-b08 |
| Test Results | https://ci-hadoop.apache.org/job/hadoop-multibranch/job/PR-5344/1/testReport/ |
| Max. process+thread count | 1264 (vs. ulimit of 5500) |
| modules | C: hadoop-common-project/hadoop-common U: hadoop-common-project/hadoop-common |
| Console output | https://ci-hadoop.apache.org/job/hadoop-multibranch/job/PR-5344/1/console |
| versions | git=2.25.1 maven=3.6.3 spotbugs=4.2.2 |
| Powered by | Apache Yetus 0.14.0 https://yetus.apache.org |
This message was automatically generated.
--
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: common-issues-unsubscribe@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org
[GitHub] [hadoop] steveloughran commented on pull request #5344: HADOOP-18576. Lack of a JavaDoc comment before annotation causes Java 11 JavaDoc failure
Posted by "steveloughran (via GitHub)" <gi...@apache.org>.
steveloughran commented on PR #5344:
URL: https://github.com/apache/hadoop/pull/5344#issuecomment-1423991215
looks like something got left out; will do a quick followup
```
[ERROR] /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-5356/ubuntu-focal/src/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/recovery/package-info.java:19: error: unknown tag: InterfaceAudience.Private
[ERROR] @InterfaceAudience.Private
[ERROR] ^
[ERROR] /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-5356/ubuntu-focal/src/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/recovery/package-info.java:20: error: unknown tag: InterfaceStability.Unstable
[ERROR] @InterfaceStability.Unstable
[ERROR] ^
```
--
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: common-issues-unsubscribe@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org
[GitHub] [hadoop] steveloughran commented on pull request #5344: HADOOP-18616. Java 11 JavaDoc fails due to missing package comments
Posted by "steveloughran (via GitHub)" <gi...@apache.org>.
steveloughran commented on PR #5344:
URL: https://github.com/apache/hadoop/pull/5344#issuecomment-1415651771
it does fix 29 of the complaints though, which #5226 didn't.
is it just the lack of a doc comment which broke things then, not the @interfaceAudience tag? if so, yes, let's merge -but use the original JIRA ID
--
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: common-issues-unsubscribe@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org
[GitHub] [hadoop] slfan1989 commented on pull request #5344: HADOOP-18616. Java 11 JavaDoc fails due to missing package comments
Posted by "slfan1989 (via GitHub)" <gi...@apache.org>.
slfan1989 commented on PR #5344:
URL: https://github.com/apache/hadoop/pull/5344#issuecomment-1416637414
> it does fix 29 of the complaints though, which https://github.com/apache/hadoop/pull/5226 didn't.
is it just the lack of a doc comment which broke things then, not the @interfaceAudience tag? if so, yes, let's merge -but use the original JIRA ID
I also don't think it's a tag issue, we can modify doc comment to solve this issue.
@snmvaughan Thank you for your contribution, but can you modify the title of the pr, as suggested by @steveloughran
--
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: common-issues-unsubscribe@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org
[GitHub] [hadoop] steveloughran merged pull request #5344: HADOOP-18576. Lack of a JavaDoc comment before annotation causes Java 11 JavaDoc failure
Posted by "steveloughran (via GitHub)" <gi...@apache.org>.
steveloughran merged PR #5344:
URL: https://github.com/apache/hadoop/pull/5344
--
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: common-issues-unsubscribe@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org
[GitHub] [hadoop] ayushtkn commented on pull request #5344: HADOOP-18616. Java 11 JavaDoc fails due to missing package comments
Posted by "ayushtkn (via GitHub)" <gi...@apache.org>.
ayushtkn commented on PR #5344:
URL: https://github.com/apache/hadoop/pull/5344#issuecomment-1415328592
Dupes #5226 / HADOOP-18576
--
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: common-issues-unsubscribe@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org
[GitHub] [hadoop] ayushtkn commented on pull request #5344: HADOOP-18576. Lack of a JavaDoc comment before annotation causes Java 11 JavaDoc failure
Posted by "ayushtkn (via GitHub)" <gi...@apache.org>.
ayushtkn commented on PR #5344:
URL: https://github.com/apache/hadoop/pull/5344#issuecomment-1423718907
This is one Jenkins report from yesterday:
https://github.com/apache/hadoop/pull/5356#issuecomment-1421193933
And the Javadoc build failed here:
**Trunk:**
https://ci-hadoop.apache.org/job/hadoop-multibranch/job/PR-5356/3/artifact/out/branch-javadoc-root-jdkUbuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04.txt
**Patch**
https://ci-hadoop.apache.org/job/hadoop-multibranch/job/PR-5356/3/artifact/out/patch-javadoc-root-jdkUbuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04.txt
With the same error I posted above. Just posting as FYI., @steveloughran I hope that was intentional while merging this, like we just want to fix this much?
The branch had this commit as well(4th in the list):
https://github.com/virajjasani/hadoop/commits/HADOOP-18620-trunk
--
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: common-issues-unsubscribe@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org
[GitHub] [hadoop] steveloughran commented on pull request #5344: HADOOP-18576. Lack of a JavaDoc comment before annotation causes Java 11 JavaDoc failure
Posted by "steveloughran (via GitHub)" <gi...@apache.org>.
steveloughran commented on PR #5344:
URL: https://github.com/apache/hadoop/pull/5344#issuecomment-1423986299
the goal is to shut javadoc up...
--
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: common-issues-unsubscribe@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org
[GitHub] [hadoop] snmvaughan commented on pull request #5344: HADOOP-18616. Java 11 JavaDoc fails due to missing package comments
Posted by "snmvaughan (via GitHub)" <gi...@apache.org>.
snmvaughan commented on PR #5344:
URL: https://github.com/apache/hadoop/pull/5344#issuecomment-1416148548
This is different because it addresses the JavaDoc errors. I'd be happy with any fix that unblocks other pull requests.
--
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: common-issues-unsubscribe@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org
[GitHub] [hadoop] snmvaughan commented on pull request #5344: HADOOP-18616. Lack of a JavaDoc comment before annotation causes Java 11 JavaDoc failure
Posted by "snmvaughan (via GitHub)" <gi...@apache.org>.
snmvaughan commented on PR #5344:
URL: https://github.com/apache/hadoop/pull/5344#issuecomment-1419355213
I looked at the class JavaDoc comments and tried to come up with something useful for the package JavaDoc. I think a brute force approach (which does work) would be to add empty comments above the annotations to address the errors.
```
/**
*/
@InterfaceAudience.LimitedPrivate({"HDFS", "MapReduce"})
@InterfaceStability.Unstable
```
--
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: common-issues-unsubscribe@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org
[GitHub] [hadoop] steveloughran commented on pull request #5344: HADOOP-18576. Lack of a JavaDoc comment before annotation causes Java 11 JavaDoc failure
Posted by "steveloughran (via GitHub)" <gi...@apache.org>.
steveloughran commented on PR #5344:
URL: https://github.com/apache/hadoop/pull/5344#issuecomment-1419545882
ok, in trunk.
@snmvaughan can you cherrypick the pr into branch-3.3 and resubmit it to see how yetus reacts there.
--
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: common-issues-unsubscribe@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org
[GitHub] [hadoop] snmvaughan commented on pull request #5344: HADOOP-18616. Lack of a JavaDoc comment before annotation causes Java 11 JavaDoc failure
Posted by "snmvaughan (via GitHub)" <gi...@apache.org>.
snmvaughan commented on PR #5344:
URL: https://github.com/apache/hadoop/pull/5344#issuecomment-1419381116
I tested this fix in the development environment you get from running `start-build-env.sh`, starting with `trunk`. Within that environment:
1. I ran Javadoc using Java 8 without an issue
2. Swtiched to Java 11 and got the errors
3. Applied the patch and re-ran Java 11 JavaDoc without errors
--
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: common-issues-unsubscribe@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org
[GitHub] [hadoop] snmvaughan commented on pull request #5344: HADOOP-18576. Lack of a JavaDoc comment before annotation causes Java 11 JavaDoc failure
Posted by "snmvaughan (via GitHub)" <gi...@apache.org>.
snmvaughan commented on PR #5344:
URL: https://github.com/apache/hadoop/pull/5344#issuecomment-1420917598
I've submitted PR #5362
--
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: common-issues-unsubscribe@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org
[GitHub] [hadoop] snmvaughan commented on pull request #5344: HADOOP-18576. Lack of a JavaDoc comment before annotation causes Java 11 JavaDoc failure
Posted by "snmvaughan (via GitHub)" <gi...@apache.org>.
snmvaughan commented on PR #5344:
URL: https://github.com/apache/hadoop/pull/5344#issuecomment-1424445817
I was focussing on those modules that were holding up other PRs I've submitted. The same technique could be applied to all modules.
--
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: common-issues-unsubscribe@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org