Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[improve][misc] use SLASHSTAR_STYLE for Java files #17508

Closed
wants to merge 10 commits into from

Conversation

tisonkun
Copy link
Member

@tisonkun tisonkun commented Sep 7, 2022

  • doc-not-needed

!THIS IS A TRIVIAL CHANGE!

The effective change is 40f4fea.

Then run mvn initialize license:format to change:

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * ...
 */

to:

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * ...
 */

Motivation

When reformatting Java files, JAVADOC_STYLE cause the license header be treated as doc comments and it will be affected from:

/**
 * ...
 * 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,
 * ...
 */

to

/**
 * ...
 * with the License.  You may obtain a copy of the License at
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * Unless required by applicable law or agreed to in writing,
 * ...
 */

This is annoying while we can replace JAVADOC_STYLE with SLASHSTAR_STYLE and it won't be an issue anymore.

Since I can simply rerun the command and even other patches should never touch these lines, this patch isn't in a hurry or suffers from conflict. But since we don't require all PR to be up-to-date before merging, we can experience a stage master failed on license:check.

@tisonkun

This comment was marked as outdated.

@github-actions github-actions bot added the doc-not-needed Your PR changes do not impact docs label Sep 7, 2022
@tisonkun tisonkun force-pushed the SLASHSTAR_STYLE-license branch from 7d87bc1 to 8b74cd8 Compare September 8, 2022 02:31
@tisonkun
Copy link
Member Author

@tisonkun
Copy link
Member Author

@merlimat what do you think of this proposal?

@github-actions
Copy link

The pr had no activity for 30 days, mark with Stale label.

@github-actions github-actions bot added the Stale label Oct 17, 2022
@tisonkun
Copy link
Member Author

Closed for a brand new patch.

@tisonkun tisonkun closed this Oct 24, 2022
@tisonkun tisonkun deleted the SLASHSTAR_STYLE-license branch October 24, 2022 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-not-needed Your PR changes do not impact docs Stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant