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

HADOOP-18576. Java 11 JavaDoc fails due to missing package comments #5362

Merged

Conversation

snmvaughan
Copy link
Contributor

Description of PR

Add JavaDoc comments to package-info.java to avoid errors resulting from the use of Hadoop annotations.

This is a backport from "HADOOP-18616. Java 11 JavaDoc fails due to missing package comments", which has been relabelled as "HADOOP-18576. Java 11 JavaDoc fails due to missing package comments".

How was this patch tested?

Ran JavaDoc using Java 11 in the Hadoop development environment docker image. There were no errors.

For code changes:

  • 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?
  • If applicable, have you updated the LICENSE, LICENSE-binary, NOTICE-binary files?

@slfan1989
Copy link
Contributor

LGTM. @snmvaughan Thanks for your contribution!

@hadoop-yetus
Copy link

💔 -1 overall

Vote Subsystem Runtime Logfile Comment
+0 🆗 reexec 14m 49s Docker mode activated.
_ Prechecks _
+1 💚 dupname 0m 1s No case conflicting files found.
+0 🆗 codespell 0m 0s codespell was not available.
+0 🆗 detsecrets 0m 0s detect-secrets was not available.
+1 💚 @author 0m 0s The patch does not contain any @author tags.
-1 ❌ 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.
_ branch-3.3 Compile Tests _
+1 💚 mvninstall 45m 5s branch-3.3 passed
+1 💚 compile 18m 34s branch-3.3 passed
+1 💚 checkstyle 0m 54s branch-3.3 passed
+1 💚 mvnsite 1m 32s branch-3.3 passed
+1 💚 javadoc 0m 45s branch-3.3 passed
+1 💚 spotbugs 2m 33s branch-3.3 passed
+1 💚 shadedclient 30m 3s branch has no errors when building and testing our client artifacts.
_ Patch Compile Tests _
+1 💚 mvninstall 1m 4s the patch passed
+1 💚 compile 17m 57s the patch passed
+1 💚 javac 17m 57s the patch passed
+1 💚 blanks 0m 0s The patch has no blanks issues.
+1 💚 checkstyle 0m 46s hadoop-common-project/hadoop-common: The patch generated 0 new + 0 unchanged - 15 fixed = 0 total (was 15)
+1 💚 mvnsite 1m 30s the patch passed
+1 💚 javadoc 0m 38s the patch passed
+1 💚 spotbugs 2m 36s the patch passed
+1 💚 shadedclient 29m 59s patch has no errors when building and testing our client artifacts.
_ Other Tests _
+1 💚 unit 17m 26s hadoop-common in the patch passed.
+1 💚 asflicense 0m 52s The patch does not generate ASF License warnings.
186m 16s
Subsystem Report/Notes
Docker ClientAPI=1.42 ServerAPI=1.42 base: https://ci-hadoop.apache.org/job/hadoop-multibranch/job/PR-5362/1/artifact/out/Dockerfile
GITHUB PR #5362
Optional Tests dupname asflicense compile javac javadoc mvninstall mvnsite unit shadedclient spotbugs checkstyle codespell detsecrets
uname Linux b77fc7986fd0 4.15.0-197-generic #208-Ubuntu SMP Tue Nov 1 17:23:37 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
Build tool maven
Personality dev-support/bin/hadoop.sh
git revision branch-3.3 / 00b5f7e
Default Java Private Build-1.8.0_352-8u352-ga-1~18.04-b08
Test Results https://ci-hadoop.apache.org/job/hadoop-multibranch/job/PR-5362/1/testReport/
Max. process+thread count 1287 (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-5362/1/console
versions git=2.17.1 maven=3.6.0 spotbugs=4.2.2
Powered by Apache Yetus 0.14.0 https://yetus.apache.org

This message was automatically generated.

…pache#5344)


Add JavaDoc comments to package-info.java to avoid errors resulting from the use of Hadoop annotations.

Contributed by Steve Vaughan Jr
@hadoop-yetus
Copy link

💔 -1 overall

Vote Subsystem Runtime Logfile Comment
+0 🆗 reexec 10m 27s Docker mode activated.
_ Prechecks _
+1 💚 dupname 0m 1s No case conflicting files found.
+0 🆗 codespell 0m 0s codespell was not available.
+0 🆗 detsecrets 0m 0s detect-secrets was not available.
+1 💚 @author 0m 0s The patch does not contain any @author tags.
-1 ❌ 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.
_ branch-3.3 Compile Tests _
+1 💚 mvninstall 54m 45s branch-3.3 passed
+1 💚 compile 19m 44s branch-3.3 passed
+1 💚 checkstyle 0m 55s branch-3.3 passed
+1 💚 mvnsite 1m 39s branch-3.3 passed
+1 💚 javadoc 0m 48s branch-3.3 passed
+1 💚 spotbugs 2m 38s branch-3.3 passed
+1 💚 shadedclient 42m 46s branch has no errors when building and testing our client artifacts.
_ Patch Compile Tests _
+1 💚 mvninstall 1m 2s the patch passed
+1 💚 compile 19m 6s the patch passed
+1 💚 javac 19m 6s the patch passed
+1 💚 blanks 0m 0s The patch has no blanks issues.
+1 💚 checkstyle 0m 54s hadoop-common-project/hadoop-common: The patch generated 0 new + 0 unchanged - 15 fixed = 0 total (was 15)
+1 💚 mvnsite 1m 38s the patch passed
+1 💚 javadoc 0m 44s the patch passed
+1 💚 spotbugs 2m 44s the patch passed
+1 💚 shadedclient 42m 49s patch has no errors when building and testing our client artifacts.
_ Other Tests _
+1 💚 unit 18m 4s hadoop-common in the patch passed.
+1 💚 asflicense 0m 57s The patch does not generate ASF License warnings.
223m 41s
Subsystem Report/Notes
Docker ClientAPI=1.43 ServerAPI=1.43 base: https://ci-hadoop.apache.org/job/hadoop-multibranch/job/PR-5362/2/artifact/out/Dockerfile
GITHUB PR #5362
Optional Tests dupname asflicense compile javac javadoc mvninstall mvnsite unit shadedclient spotbugs checkstyle codespell detsecrets
uname Linux 92559c8bab0d 4.15.0-212-generic #223-Ubuntu SMP Tue May 23 13:09:22 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux
Build tool maven
Personality dev-support/bin/hadoop.sh
git revision branch-3.3 / 8abad48
Default Java Private Build-1.8.0_362-8u372-gaus1-0ubuntu118.04-b09
Test Results https://ci-hadoop.apache.org/job/hadoop-multibranch/job/PR-5362/2/testReport/
Max. process+thread count 1375 (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-5362/2/console
versions git=2.17.1 maven=3.6.0 spotbugs=4.2.2
Powered by Apache Yetus 0.14.0 https://yetus.apache.org

This message was automatically generated.

Copy link
Contributor

@steveloughran steveloughran left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@steveloughran steveloughran merged commit ed7aecf into apache:branch-3.3 Sep 19, 2023
0 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants