[ZOOKEEPER-4651] Fix checkstyle problems on branch-3.6

• Type: Task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 3.6.4
• Labels: pull-request-available
• Assignee: Mate Szalay-Beko
• Reporter: Mate Szalay-Beko
• Created: 14/Dec/22 09:56
• Updated: 14/Dec/22 13:16
• Resolved: 14/Dec/22 13:14

Description

Checkstyle was upgraded to 8.39 in ZOOKEEPER-4644 and it doesn't work properly on current branch 3.6. Given that branch 3.6 won't be actively developed in the future, I decided to downgrade checkstyle back to 8.19 instead of fixing the checkstyle config or re-format the code.

But even after downgrade, checkstyle fails on branch-3.6 with the following error. We need to fix it before release 3.6.4

[INFO] There are 4 errors reported by Checkstyle 8.19 with checkstyle-strict.xml ruleset.
[ERROR] src/test/java/org/apache/zookeeper/compatibility/TestApacheCuratorCompatibility.java:[9] (javadoc) JavadocParagraph: <p> tag should be placed immediately before the first word, with no space after.
[ERROR] src/test/java/org/apache/zookeeper/compatibility/TestApacheCuratorCompatibility.java:[9] (javadoc) JavadocParagraph: <p> tag should be preceded with an empty line.
[ERROR] src/test/java/org/apache/zookeeper/compatibility/TestApacheCuratorCompatibility.java:[11] (javadoc) JavadocParagraph: <p> tag should be placed immediately before the first word, with no space after.
[ERROR] src/test/java/org/apache/zookeeper/compatibility/TestApacheCuratorCompatibility.java:[11] (javadoc) JavadocParagraph: <p> tag should be preceded with an empty line.

(...)

 [ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.1.0:check (default-cli) on project zookeeper-compatibility-tests-curator: You have 4 Checkstyle violations. -> [Help 1]

 

Issue Links

• links to: GitHub Pull Request #1965