You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@pulsar.apache.org by tison <wa...@gmail.com> on 2022/10/21 01:45:05 UTC
[DISCUSS] Use SLASHSTAR_STYLE for Java files
Hi,
Here is the pull request: https://github.com/apache/pulsar/pull/17508
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 and actually fails the license check, while we can replace
JAVADOC_STYLE with SLASHSTAR_STYLE and it won't be an issue anymore.
Especially after https://github.com/apache/pulsar/pull/18142 merged, we
globally enable checkstyle rules so that the action above will become more
and more frequent.
Looking forward to your feedback.
Best,
tison.
[COMMITTER ATTENTION] Possible conflict on code style
Posted by tison <wa...@gmail.com>.
Now PR 18177 is merged. Because we don't require a patch merged should be
up-to-date on the latest master, we already check in some patches using a
different code style.
Please try to ask the PR author to run `mvn initialize license:format` to
reformat if they add new files.
Don't get confused when you find a new PR failed on format check failure of
files you don't touch :)
Best,
tison.
---------- Forwarded message ---------
发件人： tison <wa...@gmail.com>
Date: 2022年10月25日周二 14:01
Subject: Re: [DISCUSS] Use SLASHSTAR_STYLE for Java files
To: <de...@pulsar.apache.org>
Patch merged.
Be aware that we may suffer a period that new patches introduce regression
for the JAVADOC_STYLE license header because we don't require the patch to
be merged must be up-to-date. But the overall situation should converge.
For reviewers, if you notice that a patch adds new files, you're supposed
to ask the author to update branch onto the latest master branch.
Best,
tison.
tison <wa...@gmail.com> 于2022年10月24日周一 20:42写道：
> Patch submitted at: https://github.com/apache/pulsar/pull/18177
>
> Although I can always reapply the formatting step, I hope with can have a
> timely review stage :)
>
> Best,
> tison.
>
>
> tison <wa...@gmail.com> 于2022年10月24日周一 17:01写道：
>
>> Thanks for your feedback! Then I'm going to rebase the pull request in
>> days.
>>
>> Still waiting for comments and I may expect two or more committers help
>> with the process if we reach a consensus.
>>
>> Best,
>> tison.
>>
>>
>> Zike Yang <zi...@apache.org> 于2022年10月24日周一 13:40写道：
>>
>>> +1
>>>
>>> Thanks,
>>> Zike Yang
>>>
>>> On Mon, Oct 24, 2022 at 1:25 PM Yunze Xu <yz...@streamnative.io.invalid>
>>> wrote:
>>> >
>>> > +1 for me.
>>> >
>>> > Thanks,
>>> > Yunze
>>> >
>>> > On Fri, Oct 21, 2022 at 9:45 AM tison <wa...@gmail.com> wrote:
>>> > >
>>> > > Hi,
>>> > >
>>> > > Here is the pull request:
>>> https://github.com/apache/pulsar/pull/17508
>>> > >
>>> > > 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 and actually fails the license check, while we can
>>> replace
>>> > > JAVADOC_STYLE with SLASHSTAR_STYLE and it won't be an issue anymore.
>>> > >
>>> > > Especially after https://github.com/apache/pulsar/pull/18142
>>> merged, we
>>> > > globally enable checkstyle rules so that the action above will
>>> become more
>>> > > and more frequent.
>>> > >
>>> > > Looking forward to your feedback.
>>> > >
>>> > > Best,
>>> > > tison.
>>>
>>
Re: [DISCUSS] Use SLASHSTAR_STYLE for Java files
Posted by tison <wa...@gmail.com>.
Patch merged.
Be aware that we may suffer a period that new patches introduce regression
for the JAVADOC_STYLE license header because we don't require the patch to
be merged must be up-to-date. But the overall situation should converge.
For reviewers, if you notice that a patch adds new files, you're supposed
to ask the author to update branch onto the latest master branch.
Best,
tison.
tison <wa...@gmail.com> 于2022年10月24日周一 20:42写道：
> Patch submitted at: https://github.com/apache/pulsar/pull/18177
>
> Although I can always reapply the formatting step, I hope with can have a
> timely review stage :)
>
> Best,
> tison.
>
>
> tison <wa...@gmail.com> 于2022年10月24日周一 17:01写道：
>
>> Thanks for your feedback! Then I'm going to rebase the pull request in
>> days.
>>
>> Still waiting for comments and I may expect two or more committers help
>> with the process if we reach a consensus.
>>
>> Best,
>> tison.
>>
>>
>> Zike Yang <zi...@apache.org> 于2022年10月24日周一 13:40写道：
>>
>>> +1
>>>
>>> Thanks,
>>> Zike Yang
>>>
>>> On Mon, Oct 24, 2022 at 1:25 PM Yunze Xu <yz...@streamnative.io.invalid>
>>> wrote:
>>> >
>>> > +1 for me.
>>> >
>>> > Thanks,
>>> > Yunze
>>> >
>>> > On Fri, Oct 21, 2022 at 9:45 AM tison <wa...@gmail.com> wrote:
>>> > >
>>> > > Hi,
>>> > >
>>> > > Here is the pull request:
>>> https://github.com/apache/pulsar/pull/17508
>>> > >
>>> > > 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 and actually fails the license check, while we can
>>> replace
>>> > > JAVADOC_STYLE with SLASHSTAR_STYLE and it won't be an issue anymore.
>>> > >
>>> > > Especially after https://github.com/apache/pulsar/pull/18142
>>> merged, we
>>> > > globally enable checkstyle rules so that the action above will
>>> become more
>>> > > and more frequent.
>>> > >
>>> > > Looking forward to your feedback.
>>> > >
>>> > > Best,
>>> > > tison.
>>>
>>
Re: [DISCUSS] Use SLASHSTAR_STYLE for Java files
Posted by tison <wa...@gmail.com>.
Patch submitted at: https://github.com/apache/pulsar/pull/18177
Although I can always reapply the formatting step, I hope with can have a
timely review stage :)
Best,
tison.
tison <wa...@gmail.com> 于2022年10月24日周一 17:01写道：
> Thanks for your feedback! Then I'm going to rebase the pull request in
> days.
>
> Still waiting for comments and I may expect two or more committers help
> with the process if we reach a consensus.
>
> Best,
> tison.
>
>
> Zike Yang <zi...@apache.org> 于2022年10月24日周一 13:40写道：
>
>> +1
>>
>> Thanks,
>> Zike Yang
>>
>> On Mon, Oct 24, 2022 at 1:25 PM Yunze Xu <yz...@streamnative.io.invalid>
>> wrote:
>> >
>> > +1 for me.
>> >
>> > Thanks,
>> > Yunze
>> >
>> > On Fri, Oct 21, 2022 at 9:45 AM tison <wa...@gmail.com> wrote:
>> > >
>> > > Hi,
>> > >
>> > > Here is the pull request: https://github.com/apache/pulsar/pull/17508
>> > >
>> > > 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 and actually fails the license check, while we can
>> replace
>> > > JAVADOC_STYLE with SLASHSTAR_STYLE and it won't be an issue anymore.
>> > >
>> > > Especially after https://github.com/apache/pulsar/pull/18142 merged,
>> we
>> > > globally enable checkstyle rules so that the action above will become
>> more
>> > > and more frequent.
>> > >
>> > > Looking forward to your feedback.
>> > >
>> > > Best,
>> > > tison.
>>
>
Re: [DISCUSS] Use SLASHSTAR_STYLE for Java files
Posted by tison <wa...@gmail.com>.
Thanks for your feedback! Then I'm going to rebase the pull request in days.
Still waiting for comments and I may expect two or more committers help
with the process if we reach a consensus.
Best,
tison.
Zike Yang <zi...@apache.org> 于2022年10月24日周一 13:40写道：
> +1
>
> Thanks,
> Zike Yang
>
> On Mon, Oct 24, 2022 at 1:25 PM Yunze Xu <yz...@streamnative.io.invalid>
> wrote:
> >
> > +1 for me.
> >
> > Thanks,
> > Yunze
> >
> > On Fri, Oct 21, 2022 at 9:45 AM tison <wa...@gmail.com> wrote:
> > >
> > > Hi,
> > >
> > > Here is the pull request: https://github.com/apache/pulsar/pull/17508
> > >
> > > 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 and actually fails the license check, while we can
> replace
> > > JAVADOC_STYLE with SLASHSTAR_STYLE and it won't be an issue anymore.
> > >
> > > Especially after https://github.com/apache/pulsar/pull/18142 merged,
> we
> > > globally enable checkstyle rules so that the action above will become
> more
> > > and more frequent.
> > >
> > > Looking forward to your feedback.
> > >
> > > Best,
> > > tison.
>
Re: [DISCUSS] Use SLASHSTAR_STYLE for Java files
Posted by Zike Yang <zi...@apache.org>.
+1
Thanks,
Zike Yang
On Mon, Oct 24, 2022 at 1:25 PM Yunze Xu <yz...@streamnative.io.invalid> wrote:
>
> +1 for me.
>
> Thanks,
> Yunze
>
> On Fri, Oct 21, 2022 at 9:45 AM tison <wa...@gmail.com> wrote:
> >
> > Hi,
> >
> > Here is the pull request: https://github.com/apache/pulsar/pull/17508
> >
> > 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 and actually fails the license check, while we can replace
> > JAVADOC_STYLE with SLASHSTAR_STYLE and it won't be an issue anymore.
> >
> > Especially after https://github.com/apache/pulsar/pull/18142 merged, we
> > globally enable checkstyle rules so that the action above will become more
> > and more frequent.
> >
> > Looking forward to your feedback.
> >
> > Best,
> > tison.
Re: [DISCUSS] Use SLASHSTAR_STYLE for Java files
Posted by Yunze Xu <yz...@streamnative.io.INVALID>.
+1 for me.
Thanks,
Yunze
On Fri, Oct 21, 2022 at 9:45 AM tison <wa...@gmail.com> wrote:
>
> Hi,
>
> Here is the pull request: https://github.com/apache/pulsar/pull/17508
>
> 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 and actually fails the license check, while we can replace
> JAVADOC_STYLE with SLASHSTAR_STYLE and it won't be an issue anymore.
>
> Especially after https://github.com/apache/pulsar/pull/18142 merged, we
> globally enable checkstyle rules so that the action above will become more
> and more frequent.
>
> Looking forward to your feedback.
>
> Best,
> tison.