HADOOP-18576. hadoop common javadocs #5226
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Change-Id: Ia6b4d0a9d4cb298270465f240ea28a47232f5579
|
💔 -1 overall
This message was automatically generated. |
moving to @public didn't take. now trying on a fully qualified import. Change-Id: I991643596fc8cba9a8e5eba7b1794fdf6e7edebd
cnauroth
requested changes
Dec 15, 2022
There was a problem hiding this comment.
Thanks for taking care of this, @steveloughran . I commented on some now-unused imports. It also looks like CI flagged a few more package infos that need changes. Are you planning on including those in this patch too?
| @InterfaceAudience.LimitedPrivate({"HBase", "HDFS", "MapReduce"}) | ||
| @InterfaceStability.Evolving | ||
| @LimitedPrivate({"HBase", "HDFS", "MapReduce"}) | ||
| @Evolving | ||
| package org.apache.hadoop.ipc; | ||
| import org.apache.hadoop.classification.InterfaceAudience; |
There was a problem hiding this comment.
It looks like these imports on lines 25 and 27 are now unused.
ayushtkn
reviewed
Dec 15, 2022
Comment on lines
+17
to
23
| * | ||
| * Erasure codec framework. | ||
| */ | ||
|
|
||
| /** | ||
| * Erasure codec framework. | ||
| */ |
Comment on lines
+17
to
23
| * | ||
| * Erasure coders framework. | ||
| */ | ||
|
|
||
| /** | ||
| * Erasure coders framework. | ||
| */ |
Comment on lines
+17
to
32
| * | ||
| * | ||
| * Raw erasure coders. | ||
| * | ||
| * Raw erasure coder is part of erasure codec framework, where erasure coder is | ||
| * used to encode/decode a group of blocks (BlockGroup) according to the codec | ||
| * specific BlockGroup layout and logic. An erasure coder extracts chunks of | ||
| * data from the blocks and can employ various low level raw erasure coders to | ||
| * perform encoding/decoding against the chunks. | ||
| * | ||
| * To distinguish from erasure coder, here raw erasure coder is used to mean the | ||
| * low level constructs, since it only takes care of the math calculation with | ||
| * a group of byte buffers. | ||
| */ | ||
|
|
||
| /** |
There was a problem hiding this comment.
ok again, the same thing is below & why are we having it as part of licence header?
|
💔 -1 overall
This message was automatically generated. |
ayushtkn
reviewed
Dec 15, 2022
There was a problem hiding this comment.
Some more findings over here
It seems specific to Java version which we are using, should be fixed in next release
https://bugs.openjdk.org/browse/JDK-8295850
It doesn't reproduces for me with JDK-11 on my mac, because I am using 11.0.14 which seems free from this bug and only 11.0.17 is affected in 11.x line
Steps to repro:
bash start-build-env.sh
export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64/
mvn -Pdocs -DskipTests clean process-sources javadoc:javadoc-no-fork -DskipTests=true
Potential Fix, that I feel you can try
diff --git a/hadoop-project/pom.xml b/hadoop-project/pom.xml
index 17df3f14497..d223d319fb1 100644
--- a/hadoop-project/pom.xml
+++ b/hadoop-project/pom.xml
@@ -2029,6 +2029,32 @@
<additionalOptions>
<additionalOption>-Xmaxwarns 10000</additionalOption>
</additionalOptions>
+ <tags>
+ <tag>
+ <name>InterfaceStability.Stable</name>
+ <placement>X</placement>
+ </tag>
+ <tag>
+ <name>InterfaceStability.Evolving</name>
+ <placement>X</placement>
+ </tag>
+ <tag>
+ <name>InterfaceStability.Unstable</name>
+ <placement>X</placement>
+ </tag>
+ <tag>
+ <name>InterfaceAudience.Public</name>
+ <placement>X</placement>
+ </tag>
+ <tag>
+ <name>InterfaceAudience.LimitedPrivate</name>
+ <placement>X</placement>
+ </tag>
+ <tag>
+ <name>InterfaceAudience.Private</name>
+ <placement>X</placement>
+ </tag>
+ </tags>
</configuration>
</plugin>
<plugin>
I tried and got a clean build
[INFO] Apache Hadoop Cloud Storage ........................ SUCCESS [ 0.275 s]
[INFO] Apache Hadoop Cloud Storage Project ................ SUCCESS [ 0.145 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 8:31 min
[INFO] Finished at: 2022-12-15T22:19:58Z
[INFO] ------------------------------------------------------------------------
|
thanks i will try that in a a different pr; close this one. note that we are doing java11 javadocs twice, not java8 any more. have we stopped java8 builds? as i was going to raise that topic soon "can we stop java8 work?". |
java-11 javadoc is twice because once it is run on trunk without patch, the second run with your patch applied. Same goes with Java-8, it is passing in the last result
This is the patch result on JDK-8 Can check all the results here: just search javadoc |
|
we need to stop with the java8 releases |
Merged
4 tasks
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of PR
changes imports to stop javadoc complaining
How was this patch tested?
For code changes:
LICENSE,LICENSE-binary,NOTICE-binaryfiles?