You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "Atharv3221 (via GitHub)" <gi...@apache.org> on 2026/04/20 09:35:36 UTC
[PR] Upgrade checkstyle to 10.21.4 and fix Javadoc to prevent parsing errors [kafka]
Atharv3221 opened a new pull request, #22101:
URL: https://github.com/apache/kafka/pull/22101
MINOR:
Upgrade checkstyle to 10.21.4 and fix Javadoc to prevent parsing errors
Ref: https://github.com/checkstyle/checkstyle/issues/19718
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Upgrade checkstyle to 13.4.0 and fix Javadoc to prevent parsing errors [kafka]
Posted by "Atharv3221 (via GitHub)" <gi...@apache.org>.
Atharv3221 commented on code in PR #22101:
URL: https://github.com/apache/kafka/pull/22101#discussion_r3111027027
##########
tools/src/main/java/org/apache/kafka/tools/ConfigCommand.java:
##########
@@ -92,21 +92,22 @@
* This script can be used to change configs for topics/clients/users/brokers/ips/client-metrics/groups dynamically
* An entity described or altered by the command may be one of:
* <ul>
- * <li> topic: --topic <topic> OR --entity-type topics --entity-name <topic>
- * <li> client: --client <client> OR --entity-type clients --entity-name <client-id>
- * <li> user: --user <user-principal> OR --entity-type users --entity-name <user-principal>
- * <li> <user, client>: --user <user-principal> --client <client-id> OR
- * --entity-type users --entity-name <user-principal> --entity-type clients --entity-name <client-id>
- * <li> broker: --broker <broker-id> OR --entity-type brokers --entity-name <broker-id>
- * <li> broker-logger: --broker-logger <broker-id> OR --entity-type broker-loggers --entity-name <broker-id>
- * <li> ip: --ip <ip> OR --entity-type ips --entity-name <ip>
- * <li> client-metrics: --client-metrics <name> OR --entity-type client-metrics --entity-name <name>
- * <li> group: --group <group> OR --entity-type groups --entity-name <group>
+ * <li> topic: {@code --topic <topic>} OR {@code --entity-type topics --entity-name <topic>}
+ * <li> client: {@code --client <client>} OR {@code --entity-type clients --entity-name <client-id>}
+ * <li> user: {@code --user <user-principal>} OR {@code --entity-type users --entity-name <user-principal>}
+ * <li> {@literal <user, client>}: {@code --user <user-principal> --client <client-id>} OR
Review Comment:
yes, it can be unified
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Upgrade checkstyle to 13.4.0 and fix Javadoc to prevent parsing errors [kafka]
Posted by "romani (via GitHub)" <gi...@apache.org>.
romani commented on code in PR #22101:
URL: https://github.com/apache/kafka/pull/22101#discussion_r3123963794
##########
gradle/dependencies.gradle:
##########
@@ -56,7 +56,7 @@ versions += [
bcpkix: "1.83",
caffeine: "3.2.0",
bndlib: "7.1.0",
- checkstyle: project.hasProperty('checkstyleVersion') ? checkstyleVersion : "12.3.1",
+ checkstyle: project.hasProperty('checkstyleVersion') ? checkstyleVersion : "13.4.0",
Review Comment:
@Atharv3221 , please revert this change .
migration to new JDK is big effort.
instead , please try to update checkstyle config to see if they can bypass violation by usage of `<property name="processJavadoc" value="false"/>` is this our recomended approach for people who do not write correct javadocs (parse-able by grammar).
If with new property in config, there is no violations, I would recommend to keep new property until migration to 13.4.0+ happens.
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Fix Javadoc for ConfigCommand.java [kafka]
Posted by "chia7712 (via GitHub)" <gi...@apache.org>.
chia7712 merged PR #22101:
URL: https://github.com/apache/kafka/pull/22101
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Fix Javadoc for ConfigCommand.java [kafka]
Posted by "Atharv3221 (via GitHub)" <gi...@apache.org>.
Atharv3221 commented on PR #22101:
URL: https://github.com/apache/kafka/pull/22101#issuecomment-4321585419
@mingyen066
with checktyle version 13.4.0 and without this changes
```
> Task :tools:checkstyleMain
[ant:checkstyle] [ERROR] /home/atharv/Desktop/oss/kafka/tools/src/main/java/org/apache/kafka/tools/ConfigCommand.java:109: Javadoc comment at column 39 has parse error. Details: token recognition error at: '|' while parsing brokers [UnusedImports]
> Task :tools:checkstyleMain FAILED
```
so no error kafka was disable at: https://github.com/checkstyle/checkstyle/commit/541330365617c0e16df5c77d7891a82fdc5dcf89
Approach of using <property name="processJavadoc" value="false"/> fails due to
Reason: https://github.com/apache/kafka/actions/runs/24890354437/job/72880857939
After changes
`./gradlew checkstyleMain checkstyleTest spotlessCheck` passes even with checkstyle version 13.4.0
After the merge https://github.com/checkstyle/checkstyle/issues/19718 no error kafka can be activated
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Fix Javadoc for ConfigCommand.java [kafka]
Posted by "romani (via GitHub)" <gi...@apache.org>.
romani commented on PR #22101:
URL: https://github.com/apache/kafka/pull/22101#issuecomment-4314224555
Such property is not an option, we need to come back to approach with javadoc fix to be parse able
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Set processJavadoc=false in checkstyle config to bypass parse errors [kafka]
Posted by "Atharv3221 (via GitHub)" <gi...@apache.org>.
Atharv3221 commented on code in PR #22101:
URL: https://github.com/apache/kafka/pull/22101#discussion_r3137881312
##########
gradle/dependencies.gradle:
##########
@@ -56,7 +56,7 @@ versions += [
bcpkix: "1.83",
caffeine: "3.2.0",
bndlib: "7.1.0",
- checkstyle: project.hasProperty('checkstyleVersion') ? checkstyleVersion : "12.3.1",
+ checkstyle: project.hasProperty('checkstyleVersion') ? checkstyleVersion : "13.4.0",
Review Comment:
Here javadoc (parse error) is only seen with one class https://github.com/apache/kafka/blob/trunk/tools/src/main/java/org/apache/kafka/tools/ConfigCommand.java for checkstyle-13.4.0
but using <property name="processJavadoc" value="false"/> here won't be good
Reason: https://github.com/apache/kafka/actions/runs/24890354437/job/72880857939
I am fixing javadoc for the file
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Upgrade checkstyle to 13.4.0 and fix Javadoc to prevent parsing errors [kafka]
Posted by "mingyen066 (via GitHub)" <gi...@apache.org>.
mingyen066 commented on code in PR #22101:
URL: https://github.com/apache/kafka/pull/22101#discussion_r3110927326
##########
tools/src/main/java/org/apache/kafka/tools/ConfigCommand.java:
##########
@@ -92,21 +92,22 @@
* This script can be used to change configs for topics/clients/users/brokers/ips/client-metrics/groups dynamically
* An entity described or altered by the command may be one of:
* <ul>
- * <li> topic: --topic <topic> OR --entity-type topics --entity-name <topic>
- * <li> client: --client <client> OR --entity-type clients --entity-name <client-id>
- * <li> user: --user <user-principal> OR --entity-type users --entity-name <user-principal>
- * <li> <user, client>: --user <user-principal> --client <client-id> OR
- * --entity-type users --entity-name <user-principal> --entity-type clients --entity-name <client-id>
- * <li> broker: --broker <broker-id> OR --entity-type brokers --entity-name <broker-id>
- * <li> broker-logger: --broker-logger <broker-id> OR --entity-type broker-loggers --entity-name <broker-id>
- * <li> ip: --ip <ip> OR --entity-type ips --entity-name <ip>
- * <li> client-metrics: --client-metrics <name> OR --entity-type client-metrics --entity-name <name>
- * <li> group: --group <group> OR --entity-type groups --entity-name <group>
+ * <li> topic: {@code --topic <topic>} OR {@code --entity-type topics --entity-name <topic>}
+ * <li> client: {@code --client <client>} OR {@code --entity-type clients --entity-name <client-id>}
+ * <li> user: {@code --user <user-principal>} OR {@code --entity-type users --entity-name <user-principal>}
+ * <li> {@literal <user, client>}: {@code --user <user-principal> --client <client-id>} OR
Review Comment:
Why some use @literal and some use @code?
Could it be unified?
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Upgrade checkstyle to 13.4.0 and fix Javadoc to prevent parsing errors [kafka]
Posted by "Atharv3221 (via GitHub)" <gi...@apache.org>.
Atharv3221 commented on PR #22101:
URL: https://github.com/apache/kafka/pull/22101#issuecomment-4287716975
Ping @chia7712
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Upgrade checkstyle to 13.4.0 and fix Javadoc to prevent parsing errors [kafka]
Posted by "mingyen066 (via GitHub)" <gi...@apache.org>.
mingyen066 commented on code in PR #22101:
URL: https://github.com/apache/kafka/pull/22101#discussion_r3110927326
##########
tools/src/main/java/org/apache/kafka/tools/ConfigCommand.java:
##########
@@ -92,21 +92,22 @@
* This script can be used to change configs for topics/clients/users/brokers/ips/client-metrics/groups dynamically
* An entity described or altered by the command may be one of:
* <ul>
- * <li> topic: --topic <topic> OR --entity-type topics --entity-name <topic>
- * <li> client: --client <client> OR --entity-type clients --entity-name <client-id>
- * <li> user: --user <user-principal> OR --entity-type users --entity-name <user-principal>
- * <li> <user, client>: --user <user-principal> --client <client-id> OR
- * --entity-type users --entity-name <user-principal> --entity-type clients --entity-name <client-id>
- * <li> broker: --broker <broker-id> OR --entity-type brokers --entity-name <broker-id>
- * <li> broker-logger: --broker-logger <broker-id> OR --entity-type broker-loggers --entity-name <broker-id>
- * <li> ip: --ip <ip> OR --entity-type ips --entity-name <ip>
- * <li> client-metrics: --client-metrics <name> OR --entity-type client-metrics --entity-name <name>
- * <li> group: --group <group> OR --entity-type groups --entity-name <group>
+ * <li> topic: {@code --topic <topic>} OR {@code --entity-type topics --entity-name <topic>}
+ * <li> client: {@code --client <client>} OR {@code --entity-type clients --entity-name <client-id>}
+ * <li> user: {@code --user <user-principal>} OR {@code --entity-type users --entity-name <user-principal>}
+ * <li> {@literal <user, client>}: {@code --user <user-principal> --client <client-id>} OR
Review Comment:
Why do some use @literal and others use @code?
Could they be unified?
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Fix Javadoc for ConfigCommand.java [kafka]
Posted by "romani (via GitHub)" <gi...@apache.org>.
romani commented on PR #22101:
URL: https://github.com/apache/kafka/pull/22101#issuecomment-4331764197
@mingyen066, please let us know if there is still any concerns.
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Fix Javadoc for ConfigCommand.java [kafka]
Posted by "romani (via GitHub)" <gi...@apache.org>.
romani commented on PR #22101:
URL: https://github.com/apache/kafka/pull/22101#issuecomment-4314101640
`Error: eckstyle] [ERROR] /home/runner/work/kafka/kafka/clients/src/main/java/org/apache/kafka/clients/consumer/internals/ShareConsumerImpl.java:35:8: Unused import - org.apache.kafka.clients.consumer.internals.events.CompletableApplicationEvent. [UnusedImports]`
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Fix Javadoc for ConfigCommand.java [kafka]
Posted by "Atharv3221 (via GitHub)" <gi...@apache.org>.
Atharv3221 commented on PR #22101:
URL: https://github.com/apache/kafka/pull/22101#issuecomment-4313642299
> Could you avoid force pushing after PR comments are left? It makes it harder to track the diff.
Okay
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Fix Javadoc for ConfigCommand.java [kafka]
Posted by "mingyen066 (via GitHub)" <gi...@apache.org>.
mingyen066 commented on PR #22101:
URL: https://github.com/apache/kafka/pull/22101#issuecomment-4313502121
Could you avoid force pushing after PR comments are left? It makes it harder to track the diff.
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org