You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@tez.apache.org by "lewismc (via GitHub)" <gi...@apache.org> on 2026/03/16 23:50:40 UTC
[PR] TEZ-4694 Add package-level Javadoc descriptions so generated API docs show a short summary for each package [tez]
lewismc opened a new pull request, #466:
URL: https://github.com/apache/tez/pull/466
PR for [TEZ-4694](https://issues.apache.org/jira/browse/TEZ-4694)
Although this is a large PR is is fairly trivial.
## Package-level Javadoc
* Added short package descriptions to existing package-info.java files across tez-api, tez-common, tez-dag, tez-mapreduce, tez-runtime-library, and tez-javadoc-tools.
* Introduced package-info.java for API packages that had none.
## Javadoc
* Fixed Javadoc warnings by escaping HTML in comments (e.g. &, <, <=) in tez-api, tez-runtime-library, and tez-mapreduce.
## Build
* Registered generated-sources (e.g. protobuf output) as compile source roots via build-helper-maven-plugin in tez-mapreduce, tez-runtime-library, tez-runtime-internals, and tez-dag.
* Enabled forked compiler with increased memory for tez-mapreduce, tez-runtime-internals, and tez-dag to avoid missing .class file errors during test-compile.
--
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@tez.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] TEZ-4694 Add package-level Javadoc descriptions so generated API docs show a short summary for each package [tez]
Posted by "abstractdog (via GitHub)" <gi...@apache.org>.
abstractdog commented on PR #466:
URL: https://github.com/apache/tez/pull/466#issuecomment-4083723936
@lewismc : this is huge, thanks! left 2 minor comments
--
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@tez.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] TEZ-4694 Add package-level Javadoc descriptions so generated API docs show a short summary for each package [tez]
Posted by "abstractdog (via GitHub)" <gi...@apache.org>.
abstractdog commented on code in PR #466:
URL: https://github.com/apache/tez/pull/466#discussion_r2954556881
##########
tez-mapreduce/pom.xml:
##########
@@ -165,6 +165,32 @@
</execution>
</executions>
</plugin>
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>build-helper-maven-plugin</artifactId>
Review Comment:
I feel that the build-helper-maven-plugin and maven-compiler-plugin changes in this patch are not necessarily related to the javadoc improvements, if I'm right, can you create separate Jira for 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@tez.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] TEZ-4694 Add package-level Javadoc descriptions so generated API docs show a short summary for each package [tez]
Posted by "tez-yetus (via GitHub)" <gi...@apache.org>.
tez-yetus commented on PR #466:
URL: https://github.com/apache/tez/pull/466#issuecomment-4071856801
:broken_heart: **-1 overall**
| Vote | Subsystem | Runtime | Logfile | Comment |
|:----:|----------:|--------:|:--------:|:-------:|
| +0 :ok: | reexec | 3m 44s | | Docker mode activated. |
|||| _ Prechecks _ |
| +1 :green_heart: | dupname | 0m 0s | | No case conflicting files found. |
| +0 :ok: | detsecrets | 0m 0s | | detect-secrets was not available. |
| +0 :ok: | xmllint | 0m 0s | | xmllint 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. |
|||| _ master Compile Tests _ |
| +0 :ok: | mvndep | 2m 11s | | Maven dependency ordering for branch |
| +1 :green_heart: | mvninstall | 6m 56s | | master passed |
| +1 :green_heart: | compile | 4m 3s | | master passed |
| +1 :green_heart: | checkstyle | 3m 17s | | master passed |
| +1 :green_heart: | javadoc | 3m 16s | | master passed |
| +0 :ok: | spotbugs | 1m 11s | | tez-api in master has 545 extant spotbugs warnings. |
| +0 :ok: | spotbugs | 0m 31s | | tez-common in master has 13 extant spotbugs warnings. |
| +0 :ok: | spotbugs | 0m 32s | | tez-runtime-internals in master has 111 extant spotbugs warnings. |
| +0 :ok: | spotbugs | 0m 41s | | tez-runtime-library in master has 235 extant spotbugs warnings. |
| +0 :ok: | spotbugs | 0m 35s | | tez-mapreduce in master has 124 extant spotbugs warnings. |
| +0 :ok: | spotbugs | 0m 56s | | tez-dag in master has 749 extant spotbugs warnings. |
| +0 :ok: | spotbugs | 0m 28s | | tez-tools/tez-javadoc-tools in master has 3 extant spotbugs warnings. |
| +0 :ok: | spotbugs | 4m 2s | | root in master has 1935 extant spotbugs warnings. |
|||| _ Patch Compile Tests _ |
| +0 :ok: | mvndep | 0m 10s | | Maven dependency ordering for patch |
| +1 :green_heart: | mvninstall | 4m 41s | | the patch passed |
| +1 :green_heart: | codespell | 0m 48s | | No new issues. |
| +1 :green_heart: | compile | 4m 32s | | the patch passed |
| +1 :green_heart: | javac | 4m 32s | | the patch passed |
| +1 :green_heart: | blanks | 0m 0s | | The patch has no blanks issues. |
| +1 :green_heart: | checkstyle | 2m 40s | | the patch passed |
| +1 :green_heart: | javadoc | 0m 37s | | tez-api generated 0 new + 0 unchanged - 10 fixed = 0 total (was 10) |
| +1 :green_heart: | javadoc | 0m 17s | | tez-common in the patch passed. |
| +1 :green_heart: | javadoc | 0m 15s | | tez-runtime-internals in the patch passed. |
| +1 :green_heart: | javadoc | 0m 22s | | tez-runtime-library generated 0 new + 0 unchanged - 8 fixed = 0 total (was 8) |
| +1 :green_heart: | javadoc | 0m 21s | | tez-mapreduce generated 0 new + 0 unchanged - 1 fixed = 0 total (was 1) |
| +1 :green_heart: | javadoc | 0m 17s | | tez-dag in the patch passed. |
| +1 :green_heart: | javadoc | 0m 15s | | tez-javadoc-tools in the patch passed. |
| +1 :green_heart: | javadoc | 0m 51s | | root generated 0 new + 0 unchanged - 19 fixed = 0 total (was 19) |
| +1 :green_heart: | spotbugs | 10m 10s | | the patch passed |
|||| _ Other Tests _ |
| +1 :green_heart: | unit | 2m 8s | | tez-api in the patch passed. |
| +1 :green_heart: | unit | 0m 31s | | tez-common in the patch passed. |
| +1 :green_heart: | unit | 0m 49s | | tez-runtime-internals in the patch passed. |
| +1 :green_heart: | unit | 4m 31s | | tez-runtime-library in the patch passed. |
| +1 :green_heart: | unit | 1m 7s | | tez-mapreduce in the patch passed. |
| +1 :green_heart: | unit | 5m 4s | | tez-dag in the patch passed. |
| +1 :green_heart: | unit | 0m 19s | | tez-javadoc-tools in the patch passed. |
| +1 :green_heart: | unit | 60m 39s | | root in the patch passed. |
| +1 :green_heart: | asflicense | 2m 23s | | The patch does not generate ASF License warnings. |
| | | 140m 5s | | |
| Subsystem | Report/Notes |
|----------:|:-------------|
| Docker | ClientAPI=1.54 ServerAPI=1.54 base: https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-466/1/artifact/out/Dockerfile |
| GITHUB PR | https://github.com/apache/tez/pull/466 |
| Optional Tests | dupname asflicense javac javadoc unit codespell detsecrets xmllint compile spotbugs checkstyle |
| uname | Linux 3a107fcff3c4 5.15.0-173-generic #183-Ubuntu SMP Fri Mar 6 13:29:34 UTC 2026 x86_64 x86_64 x86_64 GNU/Linux |
| Build tool | maven |
| Personality | /home/jenkins/jenkins-home/workspace/tez-multibranch_PR-466/src/.yetus/personality.sh |
| git revision | master / 1e51e7df7a309906eaa5c99217fb146e4409dd6b |
| Default Java | Ubuntu-21.0.10+7-Ubuntu-124.04 |
| Test Results | https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-466/1/testReport/ |
| Max. process+thread count | 2109 (vs. ulimit of 5500) |
| modules | C: tez-api tez-common tez-runtime-internals tez-runtime-library tez-mapreduce tez-dag tez-tools/tez-javadoc-tools . U: . |
| Console output | https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-466/1/console |
| versions | git=2.43.0 maven=3.8.7 spotbugs=4.9.3 codespell=2.4.1 |
| Powered by | Apache Yetus 0.15.1 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: issues-unsubscribe@tez.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] TEZ-4694 Add package-level Javadoc descriptions so generated API docs show a short summary for each package [tez]
Posted by "tez-yetus (via GitHub)" <gi...@apache.org>.
tez-yetus commented on PR #466:
URL: https://github.com/apache/tez/pull/466#issuecomment-4086027740
:broken_heart: **-1 overall**
| Vote | Subsystem | Runtime | Logfile | Comment |
|:----:|----------:|--------:|:--------:|:-------:|
| +0 :ok: | reexec | 4m 8s | | Docker mode activated. |
|||| _ Prechecks _ |
| +1 :green_heart: | dupname | 0m 0s | | No case conflicting files found. |
| +0 :ok: | detsecrets | 0m 0s | | detect-secrets was not available. |
| +0 :ok: | xmllint | 0m 0s | | xmllint 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. |
|||| _ master Compile Tests _ |
| +0 :ok: | mvndep | 2m 13s | | Maven dependency ordering for branch |
| +1 :green_heart: | mvninstall | 7m 11s | | master passed |
| +1 :green_heart: | compile | 4m 1s | | master passed |
| +1 :green_heart: | checkstyle | 3m 16s | | master passed |
| +1 :green_heart: | javadoc | 3m 18s | | master passed |
| +0 :ok: | spotbugs | 1m 12s | | tez-api in master has 545 extant spotbugs warnings. |
| +0 :ok: | spotbugs | 0m 28s | | tez-common in master has 13 extant spotbugs warnings. |
| +0 :ok: | spotbugs | 0m 34s | | tez-runtime-internals in master has 111 extant spotbugs warnings. |
| +0 :ok: | spotbugs | 0m 44s | | tez-runtime-library in master has 235 extant spotbugs warnings. |
| +0 :ok: | spotbugs | 0m 34s | | tez-mapreduce in master has 124 extant spotbugs warnings. |
| +0 :ok: | spotbugs | 1m 1s | | tez-dag in master has 749 extant spotbugs warnings. |
| +0 :ok: | spotbugs | 0m 26s | | tez-tools/tez-javadoc-tools in master has 3 extant spotbugs warnings. |
| +0 :ok: | spotbugs | 3m 57s | | root in master has 1935 extant spotbugs warnings. |
|||| _ Patch Compile Tests _ |
| +0 :ok: | mvndep | 0m 10s | | Maven dependency ordering for patch |
| +1 :green_heart: | mvninstall | 4m 14s | | the patch passed |
| +1 :green_heart: | codespell | 0m 48s | | No new issues. |
| +1 :green_heart: | compile | 3m 51s | | the patch passed |
| +1 :green_heart: | javac | 3m 51s | | the patch passed |
| +1 :green_heart: | blanks | 0m 0s | | The patch has no blanks issues. |
| +1 :green_heart: | checkstyle | 2m 42s | | the patch passed |
| +1 :green_heart: | javadoc | 0m 36s | | tez-api generated 0 new + 0 unchanged - 10 fixed = 0 total (was 10) |
| +1 :green_heart: | javadoc | 0m 18s | | tez-common in the patch passed. |
| +1 :green_heart: | javadoc | 0m 16s | | tez-runtime-internals in the patch passed. |
| +1 :green_heart: | javadoc | 0m 21s | | tez-runtime-library generated 0 new + 0 unchanged - 8 fixed = 0 total (was 8) |
| +1 :green_heart: | javadoc | 0m 21s | | tez-mapreduce generated 0 new + 0 unchanged - 1 fixed = 0 total (was 1) |
| +1 :green_heart: | javadoc | 0m 18s | | tez-dag in the patch passed. |
| +1 :green_heart: | javadoc | 0m 16s | | tez-javadoc-tools in the patch passed. |
| +1 :green_heart: | javadoc | 0m 51s | | root generated 0 new + 0 unchanged - 19 fixed = 0 total (was 19) |
| +1 :green_heart: | spotbugs | 9m 53s | | the patch passed |
|||| _ Other Tests _ |
| +1 :green_heart: | unit | 2m 4s | | tez-api in the patch passed. |
| +1 :green_heart: | unit | 0m 31s | | tez-common in the patch passed. |
| +1 :green_heart: | unit | 0m 46s | | tez-runtime-internals in the patch passed. |
| +1 :green_heart: | unit | 4m 29s | | tez-runtime-library in the patch passed. |
| +1 :green_heart: | unit | 1m 6s | | tez-mapreduce in the patch passed. |
| +1 :green_heart: | unit | 5m 2s | | tez-dag in the patch passed. |
| +1 :green_heart: | unit | 0m 17s | | tez-javadoc-tools in the patch passed. |
| +1 :green_heart: | unit | 60m 18s | | root in the patch passed. |
| +1 :green_heart: | asflicense | 2m 25s | | The patch does not generate ASF License warnings. |
| | | 138m 52s | | |
| Subsystem | Report/Notes |
|----------:|:-------------|
| Docker | ClientAPI=1.54 ServerAPI=1.54 base: https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-466/2/artifact/out/Dockerfile |
| GITHUB PR | https://github.com/apache/tez/pull/466 |
| Optional Tests | dupname asflicense javac javadoc unit codespell detsecrets xmllint compile spotbugs checkstyle |
| uname | Linux 66bc5a565493 5.15.0-173-generic #183-Ubuntu SMP Fri Mar 6 13:29:34 UTC 2026 x86_64 x86_64 x86_64 GNU/Linux |
| Build tool | maven |
| Personality | /home/jenkins/jenkins-home/workspace/tez-multibranch_PR-466/src/.yetus/personality.sh |
| git revision | master / c99e386b8bdb436e9c494a3df05063f403227399 |
| Default Java | Ubuntu-21.0.10+7-Ubuntu-124.04 |
| Test Results | https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-466/2/testReport/ |
| Max. process+thread count | 1355 (vs. ulimit of 5500) |
| modules | C: tez-api tez-common tez-runtime-internals tez-runtime-library tez-mapreduce tez-dag tez-tools/tez-javadoc-tools . U: . |
| Console output | https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-466/2/console |
| versions | git=2.43.0 maven=3.8.7 spotbugs=4.9.3 codespell=2.4.1 |
| Powered by | Apache Yetus 0.15.1 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: issues-unsubscribe@tez.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] TEZ-4694 Add package-level Javadoc descriptions so generated API docs show a short summary for each package [tez]
Posted by "lewismc (via GitHub)" <gi...@apache.org>.
lewismc commented on code in PR #466:
URL: https://github.com/apache/tez/pull/466#discussion_r2955999617
##########
tez-mapreduce/pom.xml:
##########
@@ -165,6 +165,32 @@
</execution>
</executions>
</plugin>
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>build-helper-maven-plugin</artifactId>
Review Comment:
Hi @abstractdog , I included them as it was the only solution to getting the project to build locally! Yes you are right, I will remove them from this PR and included them separately. Thanks.
--
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@tez.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] TEZ-4694 Add package-level Javadoc descriptions so generated API docs show a short summary for each package [tez]
Posted by "lewismc (via GitHub)" <gi...@apache.org>.
lewismc commented on PR #466:
URL: https://github.com/apache/tez/pull/466#issuecomment-4085351160
Thanks for the review @abstractdog I made the changes.
--
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@tez.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] TEZ-4694 Add package-level Javadoc descriptions so generated API docs show a short summary for each package [tez]
Posted by "abstractdog (via GitHub)" <gi...@apache.org>.
abstractdog commented on code in PR #466:
URL: https://github.com/apache/tez/pull/466#discussion_r2954476967
##########
tez-runtime-library/src/main/java/org/apache/tez/http/async/netty/package-info.java:
##########
@@ -0,0 +1,25 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Async HTTP handling using Netty for the runtime library.
Review Comment:
it's more like "using Async Http Client on top of Netty" (https://github.com/AsyncHttpClient/async-http-client): even if the name suggests, netty is not referenced by Tez here, so it's "hidden" detail
--
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@tez.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] TEZ-4694 Add package-level Javadoc descriptions so generated API docs show a short summary for each package [tez]
Posted by "abstractdog (via GitHub)" <gi...@apache.org>.
abstractdog merged PR #466:
URL: https://github.com/apache/tez/pull/466
--
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@tez.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org