HIVE-29245: Normalize Java license headers, part 1 - illegal Javadoc #6125
+221
−174
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.
What changes were proposed in this pull request?
Normalize the license headers. This pull request reformats files that don't allow the following Javadoc format. FYI: The expected header file is located at checkstyle/asf.header.
Originally, I attempted to update all at once in #6115 or #6112, but it is likely to be challenging to review. So, I created a separate pull request focusing on the minimal reformat as the first step.
Why are the changes needed?
Our CI checks the license header format of new files. Some (or most) people copy and paste the header from existing Java files. Unfortunately, existing files don't share the same format, and SonarQube often reports a license issue. A reviewer has to say "you must not copy and paste the header from existing files, you must pick it up from checkstyle/asf.header.
Does this PR introduce any user-facing change?
No
How was this patch tested?
I put the following configuration on
checkstyle/checkstyle.xml
,standalone-metastore/checkstyle/checkstyle.xml
, andstorage-api/checkstyle/checkstyle.xml. After that, I ran
mvn checkstyle:check`.How to reformat
I ran the following script to convert
\A\/\*\*$
into\A\/\\*$
.As the number of the other patterns was not so huge, everything else has been hand-maded.