You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@streampipes.apache.org by Florian Micklich <mi...@apache.org> on 2022/11/21 18:53:11 UTC
Apache License Header Format
Hi all,
I saw now two difference License headers in the code. What Option is correct? ( I know it is only a minor issue because it is only the format)
Option 1
```
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance 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, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
```
Option 2
```
/*
*
* * Licensed to the Apache Software Foundation (ASF) under one or more
* * contributor license agreements. See the NOTICE file distributed with
* * this work for additional information regarding copyright ownership.
* * The ASF licenses this file to You under the Apache License, Version 2.0
* * (the "License"); you may not use this file except in compliance 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, software
* * distributed under the License is distributed on an "AS IS" BASIS,
* * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* * See the License for the specific language governing permissions and
* * limitations under the License.
* *
*
*/
```
In markdown this is used. I will add the description here [1] that for markdown another profile has to be used.
```
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance 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, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
```
Greetings
Florian
[1] https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements
Re: AW: Apache License Header Format
Posted by Tim <bo...@posteo.de>.
Hi,
Sounds like a good plan.
I like the idea of improving the code style module by module followed by
estabalishing and extending pre-commit hooks in the mid term.
Best
Tim
Am 24.11.2022 10:59 schrieb Philipp Zehnder:
> Hi,
>
> I think it would be great if the headers could be added automatically.
> However, I am also not quite sure how this works.
> I guess a good first step is to add the check to code validation.
> Therefore, I created a PR [1] that adds the header validation to the
> checkstyle plugin.
> This currently only works for Java. Maybe we can add a similar
> functionality for other file types as well.
>
> What do you think would be a good next step?
> My suggestion would be to fix the checkstyle errors module by module
> and include the checkstyle plugin as a git pre-commit hook.
>
> Cheers,
> Philipp
>
>
> [1] https://github.com/apache/streampipes/pull/154
>
>
> Von: Tim <bo...@posteo.de>
> Datum: Mittwoch, 23. November 2022 um 22:27
> An: dev@streampipes.apache.org <de...@streampipes.apache.org>
> Betreff: Re: Apache License Header Format
> RAT only detects missing headers, but does not automatically add them,
> afaik.
> Maybe there is even an option that headers are added automatically.
>
> Best
> Tim
>
> Am 23.11.2022 14:39 schrieb Florian Micklich:
>> Hi Tim,
>>
>> ah ok good to know.
>> I though RAT is something like that. This was the name in the
>> STREAMPIPES-590 Ticket you were working on.
>>
>> Florian
>>
>>
>> Am Dienstag, dem 22.11.2022 um 19:11 +0000 schrieb Tim:
>>> Hi Florian,<br>
>>>
>>> no, there is yet no automation for Apache headers in resource
>>> files.<br>
>>> That yould be a future improvement.<br>
>>>
>>> Best<br>
>>> Tim<br>
>>>
>>> Am 22.11.2022 12:34 schrieb Florian Micklich:<br>
>>> > Hi,<br>
>>> >
>>> > I can answer my question by myself.<br>
>>> > It is Option 1.<br>
>>> >
>>> > Option 2 occurs on my side because of a "wrong" automatic Copyright <br>
>>> > text.<br>
>>> > IntelliJ is creating the commends syntax itself, that leads to option<br>
>>> > 2. If you add the text already with comment syntax, the double comment<br>
>>> > is the result.<br>
>>> >
>>> > I added the info in conf [1]<br>
>>> >
>>> > I think there is no option to make a different profile for markdown <br>
>>> > files.<br>
>>> > But this is done via STREAMPIPES-590 anyway automatically. Am I right?<br>
>>> >
>>> > Greeting<br>
>>> > Florian<br>
>>> >
>>> > [1] <br>
>>> > [https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)<br<https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements%5d(https:/cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)%3cbr>>
>>> >
>>> > Am Montag, dem 21.11.2022 um 19:53 +0100 schrieb Florian Micklich:<br>>
>>> > >
>>> > > Hi all,<br><br>
>>> > >
>>> > > I saw now two difference License headers in the code. What Option is <br>
>>> > > correct? ( I know it is only a minor issue because it is only the <br>
>>> > > format)<br><br>
>>> > >
>>> > > Option 1<br><br>
>>> > > ```<br><br>
>>> > > /*<br><br>
>>> > > * Licensed to the Apache Software Foundation (ASF) under one or <br>
>>> > > more<br><br>
>>> > > * contributor license agreements. See the NOTICE file distributed <br>
>>> > > with<br><br>
>>> > > * this work for additional information regarding copyright <br>
>>> > > ownership.<br><br>
>>> > > * The ASF licenses this file to You under the Apache License, <br>
>>> > > Version 2.0<br><br>
>>> > > * (the "License"); you may not use this file except in compliance <br>
>>> > > with<br><br>
>>> > > * the License. You may obtain a copy of the License at<br><br>
>>> > > *<br><br>
>>> > > * <br>
>>> > > [[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)](http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))<br><br<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%5d(http:/www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0))%3cbr%3e%3cbr>>
>>> > > *<br><br>
>>> > > * Unless required by applicable law or agreed to in writing, <br>
>>> > > software<br><br>
>>> > > * distributed under the License is distributed on an "AS IS" <br>
>>> > > BASIS,<br><br>
>>> > > * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or <br>
>>> > > implied.<br><br>
>>> > > * See the License for the specific language governing permissions <br>
>>> > > and<br><br>
>>> > > * limitations under the License.<br><br>
>>> > > */<br><br>
>>> > > ```<br><br>
>>> > >
>>> > >
>>> > > Option 2<br><br>
>>> > > ```<br><br>
>>> > > /*<br><br>
>>> > > *<br><br>
>>> > > * * Licensed to the Apache Software Foundation (ASF) under one or <br>
>>> > > more<br><br>
>>> > > * * contributor license agreements. See the NOTICE file distributed <br>
>>> > > with<br><br>
>>> > > * * this work for additional information regarding copyright <br>
>>> > > ownership.<br><br>
>>> > > * * The ASF licenses this file to You under the Apache License, <br>
>>> > > Version 2.0<br><br>
>>> > > * * (the "License"); you may not use this file except in compliance <br>
>>> > > with<br><br>
>>> > > * * the License. You may obtain a copy of the License at<br><br>
>>> > > * *<br><br>
>>> > > * * <br>
>>> > > [[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)](http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))<br><br<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%5d(http:/www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0))%3cbr%3e%3cbr>>
>>> > > * *<br><br>
>>> > > * * Unless required by applicable law or agreed to in writing, <br>
>>> > > software<br><br>
>>> > > * * distributed under the License is distributed on an "AS IS" <br>
>>> > > BASIS,<br><br>
>>> > > * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or <br>
>>> > > implied.<br><br>
>>> > > * * See the License for the specific language governing permissions <br>
>>> > > and<br><br>
>>> > > * * limitations under the License.<br><br>
>>> > > * *<br><br>
>>> > > *<br><br>
>>> > > */<br><br>
>>> > > ```<br><br>
>>> > >
>>> > >
>>> > > In markdown this is used. I will add the description here [1] that for <br>
>>> > > markdown another profile has to be used.<br><br>
>>> > > ```<br><br>
>>> > > #<br><br>
>>> > > # Licensed to the Apache Software Foundation (ASF) under one or <br>
>>> > > more<br><br>
>>> > > # contributor license agreements. See the NOTICE file distributed <br>
>>> > > with<br><br>
>>> > > # this work for additional information regarding copyright <br>
>>> > > ownership.<br><br>
>>> > > # The ASF licenses this file to You under the Apache License, Version <br>
>>> > > 2.0<br><br>
>>> > > # (the "License"); you may not use this file except in compliance <br>
>>> > > with<br><br>
>>> > > # the License. You may obtain a copy of the License at<br><br>
>>> > > #<br><br>
>>> > > # <br>
>>> > > [[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)](http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))<br><br<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%5d(http:/www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0))%3cbr%3e%3cbr>>
>>> > > #<br><br>
>>> > > # Unless required by applicable law or agreed to in writing, <br>
>>> > > software<br><br>
>>> > > # distributed under the License is distributed on an "AS IS" <br>
>>> > > BASIS,<br><br>
>>> > > # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or <br>
>>> > > implied.<br><br>
>>> > > # See the License for the specific language governing permissions <br>
>>> > > and<br><br>
>>> > > # limitations under the License.<br><br>
>>> > > #<br><br>
>>> > > ```<br><br>
>>> > >
>>> > > Greetings<br><br>
>>> > > Florian<br><br>
>>> > >
>>> > > [1] <br>
>>> > > [[https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements))<br><br<https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements%5d(https:/cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)%5d(https:/cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements%5d(https:/cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements))%3cbr%3e%3cbr>>
AW: Apache License Header Format
Posted by Philipp Zehnder <ph...@bytefabrik.ai>.
Hi,
I think it would be great if the headers could be added automatically. However, I am also not quite sure how this works.
I guess a good first step is to add the check to code validation. Therefore, I created a PR [1] that adds the header validation to the checkstyle plugin.
This currently only works for Java. Maybe we can add a similar functionality for other file types as well.
What do you think would be a good next step?
My suggestion would be to fix the checkstyle errors module by module and include the checkstyle plugin as a git pre-commit hook.
Cheers,
Philipp
[1] https://github.com/apache/streampipes/pull/154
Von: Tim <bo...@posteo.de>
Datum: Mittwoch, 23. November 2022 um 22:27
An: dev@streampipes.apache.org <de...@streampipes.apache.org>
Betreff: Re: Apache License Header Format
RAT only detects missing headers, but does not automatically add them,
afaik.
Maybe there is even an option that headers are added automatically.
Best
Tim
Am 23.11.2022 14:39 schrieb Florian Micklich:
> Hi Tim,
>
> ah ok good to know.
> I though RAT is something like that. This was the name in the
> STREAMPIPES-590 Ticket you were working on.
>
> Florian
>
>
> Am Dienstag, dem 22.11.2022 um 19:11 +0000 schrieb Tim:
>> Hi Florian,<br>
>>
>> no, there is yet no automation for Apache headers in resource
>> files.<br>
>> That yould be a future improvement.<br>
>>
>> Best<br>
>> Tim<br>
>>
>> Am 22.11.2022 12:34 schrieb Florian Micklich:<br>
>> > Hi,<br>
>> >
>> > I can answer my question by myself.<br>
>> > It is Option 1.<br>
>> >
>> > Option 2 occurs on my side because of a "wrong" automatic Copyright <br>
>> > text.<br>
>> > IntelliJ is creating the commends syntax itself, that leads to option<br>
>> > 2. If you add the text already with comment syntax, the double comment<br>
>> > is the result.<br>
>> >
>> > I added the info in conf [1]<br>
>> >
>> > I think there is no option to make a different profile for markdown <br>
>> > files.<br>
>> > But this is done via STREAMPIPES-590 anyway automatically. Am I right?<br>
>> >
>> > Greeting<br>
>> > Florian<br>
>> >
>> > [1] <br>
>> > [https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)<br<https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements%5d(https:/cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)%3cbr>>
>> >
>> > Am Montag, dem 21.11.2022 um 19:53 +0100 schrieb Florian Micklich:<br>>
>> > >
>> > > Hi all,<br><br>
>> > >
>> > > I saw now two difference License headers in the code. What Option is <br>
>> > > correct? ( I know it is only a minor issue because it is only the <br>
>> > > format)<br><br>
>> > >
>> > > Option 1<br><br>
>> > > ```<br><br>
>> > > /*<br><br>
>> > > * Licensed to the Apache Software Foundation (ASF) under one or <br>
>> > > more<br><br>
>> > > * contributor license agreements. See the NOTICE file distributed <br>
>> > > with<br><br>
>> > > * this work for additional information regarding copyright <br>
>> > > ownership.<br><br>
>> > > * The ASF licenses this file to You under the Apache License, <br>
>> > > Version 2.0<br><br>
>> > > * (the "License"); you may not use this file except in compliance <br>
>> > > with<br><br>
>> > > * the License. You may obtain a copy of the License at<br><br>
>> > > *<br><br>
>> > > * <br>
>> > > [[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)](http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))<br><br<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%5d(http:/www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0))%3cbr%3e%3cbr>>
>> > > *<br><br>
>> > > * Unless required by applicable law or agreed to in writing, <br>
>> > > software<br><br>
>> > > * distributed under the License is distributed on an "AS IS" <br>
>> > > BASIS,<br><br>
>> > > * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or <br>
>> > > implied.<br><br>
>> > > * See the License for the specific language governing permissions <br>
>> > > and<br><br>
>> > > * limitations under the License.<br><br>
>> > > */<br><br>
>> > > ```<br><br>
>> > >
>> > >
>> > > Option 2<br><br>
>> > > ```<br><br>
>> > > /*<br><br>
>> > > *<br><br>
>> > > * * Licensed to the Apache Software Foundation (ASF) under one or <br>
>> > > more<br><br>
>> > > * * contributor license agreements. See the NOTICE file distributed <br>
>> > > with<br><br>
>> > > * * this work for additional information regarding copyright <br>
>> > > ownership.<br><br>
>> > > * * The ASF licenses this file to You under the Apache License, <br>
>> > > Version 2.0<br><br>
>> > > * * (the "License"); you may not use this file except in compliance <br>
>> > > with<br><br>
>> > > * * the License. You may obtain a copy of the License at<br><br>
>> > > * *<br><br>
>> > > * * <br>
>> > > [[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)](http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))<br><br<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%5d(http:/www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0))%3cbr%3e%3cbr>>
>> > > * *<br><br>
>> > > * * Unless required by applicable law or agreed to in writing, <br>
>> > > software<br><br>
>> > > * * distributed under the License is distributed on an "AS IS" <br>
>> > > BASIS,<br><br>
>> > > * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or <br>
>> > > implied.<br><br>
>> > > * * See the License for the specific language governing permissions <br>
>> > > and<br><br>
>> > > * * limitations under the License.<br><br>
>> > > * *<br><br>
>> > > *<br><br>
>> > > */<br><br>
>> > > ```<br><br>
>> > >
>> > >
>> > > In markdown this is used. I will add the description here [1] that for <br>
>> > > markdown another profile has to be used.<br><br>
>> > > ```<br><br>
>> > > #<br><br>
>> > > # Licensed to the Apache Software Foundation (ASF) under one or <br>
>> > > more<br><br>
>> > > # contributor license agreements. See the NOTICE file distributed <br>
>> > > with<br><br>
>> > > # this work for additional information regarding copyright <br>
>> > > ownership.<br><br>
>> > > # The ASF licenses this file to You under the Apache License, Version <br>
>> > > 2.0<br><br>
>> > > # (the "License"); you may not use this file except in compliance <br>
>> > > with<br><br>
>> > > # the License. You may obtain a copy of the License at<br><br>
>> > > #<br><br>
>> > > # <br>
>> > > [[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)](http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))<br><br<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%5d(http:/www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0))%3cbr%3e%3cbr>>
>> > > #<br><br>
>> > > # Unless required by applicable law or agreed to in writing, <br>
>> > > software<br><br>
>> > > # distributed under the License is distributed on an "AS IS" <br>
>> > > BASIS,<br><br>
>> > > # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or <br>
>> > > implied.<br><br>
>> > > # See the License for the specific language governing permissions <br>
>> > > and<br><br>
>> > > # limitations under the License.<br><br>
>> > > #<br><br>
>> > > ```<br><br>
>> > >
>> > > Greetings<br><br>
>> > > Florian<br><br>
>> > >
>> > > [1] <br>
>> > > [[https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements))<br><br<https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements%5d(https:/cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)%5d(https:/cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements%5d(https:/cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements))%3cbr%3e%3cbr>>
Re: Apache License Header Format
Posted by Tim <bo...@posteo.de>.
RAT only detects missing headers, but does not automatically add them,
afaik.
Maybe there is even an option that headers are added automatically.
Best
Tim
Am 23.11.2022 14:39 schrieb Florian Micklich:
> Hi Tim,
>
> ah ok good to know.
> I though RAT is something like that. This was the name in the
> STREAMPIPES-590 Ticket you were working on.
>
> Florian
>
>
> Am Dienstag, dem 22.11.2022 um 19:11 +0000 schrieb Tim:
>> Hi Florian,<br>
>>
>> no, there is yet no automation for Apache headers in resource
>> files.<br>
>> That yould be a future improvement.<br>
>>
>> Best<br>
>> Tim<br>
>>
>> Am 22.11.2022 12:34 schrieb Florian Micklich:<br>
>> > Hi,<br>
>> >
>> > I can answer my question by myself.<br>
>> > It is Option 1.<br>
>> >
>> > Option 2 occurs on my side because of a "wrong" automatic Copyright <br>
>> > text.<br>
>> > IntelliJ is creating the commends syntax itself, that leads to option<br>
>> > 2. If you add the text already with comment syntax, the double comment<br>
>> > is the result.<br>
>> >
>> > I added the info in conf [1]<br>
>> >
>> > I think there is no option to make a different profile for markdown <br>
>> > files.<br>
>> > But this is done via STREAMPIPES-590 anyway automatically. Am I right?<br>
>> >
>> > Greeting<br>
>> > Florian<br>
>> >
>> > [1] <br>
>> > [https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)<br>
>> >
>> > Am Montag, dem 21.11.2022 um 19:53 +0100 schrieb Florian Micklich:<br>>
>> > >
>> > > Hi all,<br><br>
>> > >
>> > > I saw now two difference License headers in the code. What Option is <br>
>> > > correct? ( I know it is only a minor issue because it is only the <br>
>> > > format)<br><br>
>> > >
>> > > Option 1<br><br>
>> > > ```<br><br>
>> > > /*<br><br>
>> > > * Licensed to the Apache Software Foundation (ASF) under one or <br>
>> > > more<br><br>
>> > > * contributor license agreements. See the NOTICE file distributed <br>
>> > > with<br><br>
>> > > * this work for additional information regarding copyright <br>
>> > > ownership.<br><br>
>> > > * The ASF licenses this file to You under the Apache License, <br>
>> > > Version 2.0<br><br>
>> > > * (the "License"); you may not use this file except in compliance <br>
>> > > with<br><br>
>> > > * the License. You may obtain a copy of the License at<br><br>
>> > > *<br><br>
>> > > * <br>
>> > > [[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)](http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))<br><br>
>> > > *<br><br>
>> > > * Unless required by applicable law or agreed to in writing, <br>
>> > > software<br><br>
>> > > * distributed under the License is distributed on an "AS IS" <br>
>> > > BASIS,<br><br>
>> > > * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or <br>
>> > > implied.<br><br>
>> > > * See the License for the specific language governing permissions <br>
>> > > and<br><br>
>> > > * limitations under the License.<br><br>
>> > > */<br><br>
>> > > ```<br><br>
>> > >
>> > >
>> > > Option 2<br><br>
>> > > ```<br><br>
>> > > /*<br><br>
>> > > *<br><br>
>> > > * * Licensed to the Apache Software Foundation (ASF) under one or <br>
>> > > more<br><br>
>> > > * * contributor license agreements. See the NOTICE file distributed <br>
>> > > with<br><br>
>> > > * * this work for additional information regarding copyright <br>
>> > > ownership.<br><br>
>> > > * * The ASF licenses this file to You under the Apache License, <br>
>> > > Version 2.0<br><br>
>> > > * * (the "License"); you may not use this file except in compliance <br>
>> > > with<br><br>
>> > > * * the License. You may obtain a copy of the License at<br><br>
>> > > * *<br><br>
>> > > * * <br>
>> > > [[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)](http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))<br><br>
>> > > * *<br><br>
>> > > * * Unless required by applicable law or agreed to in writing, <br>
>> > > software<br><br>
>> > > * * distributed under the License is distributed on an "AS IS" <br>
>> > > BASIS,<br><br>
>> > > * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or <br>
>> > > implied.<br><br>
>> > > * * See the License for the specific language governing permissions <br>
>> > > and<br><br>
>> > > * * limitations under the License.<br><br>
>> > > * *<br><br>
>> > > *<br><br>
>> > > */<br><br>
>> > > ```<br><br>
>> > >
>> > >
>> > > In markdown this is used. I will add the description here [1] that for <br>
>> > > markdown another profile has to be used.<br><br>
>> > > ```<br><br>
>> > > #<br><br>
>> > > # Licensed to the Apache Software Foundation (ASF) under one or <br>
>> > > more<br><br>
>> > > # contributor license agreements. See the NOTICE file distributed <br>
>> > > with<br><br>
>> > > # this work for additional information regarding copyright <br>
>> > > ownership.<br><br>
>> > > # The ASF licenses this file to You under the Apache License, Version <br>
>> > > 2.0<br><br>
>> > > # (the "License"); you may not use this file except in compliance <br>
>> > > with<br><br>
>> > > # the License. You may obtain a copy of the License at<br><br>
>> > > #<br><br>
>> > > # <br>
>> > > [[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)](http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))<br><br>
>> > > #<br><br>
>> > > # Unless required by applicable law or agreed to in writing, <br>
>> > > software<br><br>
>> > > # distributed under the License is distributed on an "AS IS" <br>
>> > > BASIS,<br><br>
>> > > # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or <br>
>> > > implied.<br><br>
>> > > # See the License for the specific language governing permissions <br>
>> > > and<br><br>
>> > > # limitations under the License.<br><br>
>> > > #<br><br>
>> > > ```<br><br>
>> > >
>> > > Greetings<br><br>
>> > > Florian<br><br>
>> > >
>> > > [1] <br>
>> > > [[https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements))<br><br>
Re: Apache License Header Format
Posted by Florian Micklich <mi...@apache.org>.
Hi Tim,
ah ok good to know.
I though RAT is something like that. This was the name in the STREAMPIPES-590 Ticket you were working on.
Florian
Am Dienstag, dem 22.11.2022 um 19:11 +0000 schrieb Tim:
> Hi Florian,<br>
>
> no, there is yet no automation for Apache headers in resource files.<br>
> That yould be a future improvement.<br>
>
> Best<br>
> Tim<br>
>
> Am 22.11.2022 12:34 schrieb Florian Micklich:<br>
> > Hi,<br>
> >
> > I can answer my question by myself.<br>
> > It is Option 1.<br>
> >
> > Option 2 occurs on my side because of a "wrong" automatic Copyright <br>
> > text.<br>
> > IntelliJ is creating the commends syntax itself, that leads to option<br>
> > 2. If you add the text already with comment syntax, the double comment<br>
> > is the result.<br>
> >
> > I added the info in conf [1]<br>
> >
> > I think there is no option to make a different profile for markdown <br>
> > files.<br>
> > But this is done via STREAMPIPES-590 anyway automatically. Am I right?<br>
> >
> > Greeting<br>
> > Florian<br>
> >
> > [1] <br>
> > [https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)<br>
> >
> > Am Montag, dem 21.11.2022 um 19:53 +0100 schrieb Florian Micklich:<br>>
> > >
> > > Hi all,<br><br>
> > >
> > > I saw now two difference License headers in the code. What Option is <br>
> > > correct? ( I know it is only a minor issue because it is only the <br>
> > > format)<br><br>
> > >
> > > Option 1<br><br>
> > > ```<br><br>
> > > /*<br><br>
> > > * Licensed to the Apache Software Foundation (ASF) under one or <br>
> > > more<br><br>
> > > * contributor license agreements. See the NOTICE file distributed <br>
> > > with<br><br>
> > > * this work for additional information regarding copyright <br>
> > > ownership.<br><br>
> > > * The ASF licenses this file to You under the Apache License, <br>
> > > Version 2.0<br><br>
> > > * (the "License"); you may not use this file except in compliance <br>
> > > with<br><br>
> > > * the License. You may obtain a copy of the License at<br><br>
> > > *<br><br>
> > > * <br>
> > > [[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)](http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))<br><br>
> > > *<br><br>
> > > * Unless required by applicable law or agreed to in writing, <br>
> > > software<br><br>
> > > * distributed under the License is distributed on an "AS IS" <br>
> > > BASIS,<br><br>
> > > * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or <br>
> > > implied.<br><br>
> > > * See the License for the specific language governing permissions <br>
> > > and<br><br>
> > > * limitations under the License.<br><br>
> > > */<br><br>
> > > ```<br><br>
> > >
> > >
> > > Option 2<br><br>
> > > ```<br><br>
> > > /*<br><br>
> > > *<br><br>
> > > * * Licensed to the Apache Software Foundation (ASF) under one or <br>
> > > more<br><br>
> > > * * contributor license agreements. See the NOTICE file distributed <br>
> > > with<br><br>
> > > * * this work for additional information regarding copyright <br>
> > > ownership.<br><br>
> > > * * The ASF licenses this file to You under the Apache License, <br>
> > > Version 2.0<br><br>
> > > * * (the "License"); you may not use this file except in compliance <br>
> > > with<br><br>
> > > * * the License. You may obtain a copy of the License at<br><br>
> > > * *<br><br>
> > > * * <br>
> > > [[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)](http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))<br><br>
> > > * *<br><br>
> > > * * Unless required by applicable law or agreed to in writing, <br>
> > > software<br><br>
> > > * * distributed under the License is distributed on an "AS IS" <br>
> > > BASIS,<br><br>
> > > * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or <br>
> > > implied.<br><br>
> > > * * See the License for the specific language governing permissions <br>
> > > and<br><br>
> > > * * limitations under the License.<br><br>
> > > * *<br><br>
> > > *<br><br>
> > > */<br><br>
> > > ```<br><br>
> > >
> > >
> > > In markdown this is used. I will add the description here [1] that for <br>
> > > markdown another profile has to be used.<br><br>
> > > ```<br><br>
> > > #<br><br>
> > > # Licensed to the Apache Software Foundation (ASF) under one or <br>
> > > more<br><br>
> > > # contributor license agreements. See the NOTICE file distributed <br>
> > > with<br><br>
> > > # this work for additional information regarding copyright <br>
> > > ownership.<br><br>
> > > # The ASF licenses this file to You under the Apache License, Version <br>
> > > 2.0<br><br>
> > > # (the "License"); you may not use this file except in compliance <br>
> > > with<br><br>
> > > # the License. You may obtain a copy of the License at<br><br>
> > > #<br><br>
> > > # <br>
> > > [[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)](http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))<br><br>
> > > #<br><br>
> > > # Unless required by applicable law or agreed to in writing, <br>
> > > software<br><br>
> > > # distributed under the License is distributed on an "AS IS" <br>
> > > BASIS,<br><br>
> > > # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or <br>
> > > implied.<br><br>
> > > # See the License for the specific language governing permissions <br>
> > > and<br><br>
> > > # limitations under the License.<br><br>
> > > #<br><br>
> > > ```<br><br>
> > >
> > > Greetings<br><br>
> > > Florian<br><br>
> > >
> > > [1] <br>
> > > [[https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements))<br><br>
Re: Apache License Header Format
Posted by Christofer Dutz <ch...@c-ware.de>.
Hi Dominik,
perfect summary … the rat plugin helps you with ensuring bullet point 2, bullet point 1 I recently did manually :-(
guess bullet point 3 you could solve with shared IDE-specific template settings.
At least for IntelliJ you can define templates for new files, and these settings are separate from other things, so you can check them in without any problems.
I am sure other IDEs have similar approaches.
Chris
From: Dominik Riemer <ri...@apache.org>
Date: Thursday, 24. November 2022 at 23:15
To: dev@streampipes.apache.org <de...@streampipes.apache.org>
Subject: Re: Apache License Header Format
Hi,
just to summarize the outcome of this discussion:
* We prefer option 1 for license header styling
* Having automated checks for license headers in form of checkstyle config or pre-commit hooks is great. Just a side note, it is generally possible to have other non-ASF license headers in our code when integrating 3rd party code (e.g., MIT, but these files must be explicitly mentioned in the LICENSE file).
* License headers itself should never be added automatically as it is our responsibility to make sure correct licenses are used.
Cheers
Dominik
On 2022/11/24 20:14:19 Christofer Dutz wrote:
> Hi all,
>
> Automatically sticking Apache Headers to code isn’t a good idea.
> If someone adds something that’s copied from somewhere else, we’re actually not allowed to add Apache headers to it.
>
> Chris
>
> From: Tim <bo...@posteo.de>
> Date: Tuesday, 22. November 2022 at 20:12
> To: dev@streampipes.apache.org <de...@streampipes.apache.org>
> Subject: Re: Apache License Header Format
> Hi Florian,
>
> no, there is yet no automation for Apache headers in resource files.
> That yould be a future improvement.
>
> Best
> Tim
>
> Am 22.11.2022 12:34 schrieb Florian Micklich:
> > Hi,
> >
> > I can answer my question by myself.
> > It is Option 1.
> >
> > Option 2 occurs on my side because of a "wrong" automatic Copyright
> > text.
> > IntelliJ is creating the commends syntax itself, that leads to option
> > 2. If you add the text already with comment syntax, the double comment
> > is the result.
> >
> > I added the info in conf [1]
> >
> > I think there is no option to make a different profile for markdown
> > files.
> > But this is done via STREAMPIPES-590 anyway automatically. Am I right?
> >
> > Greeting
> > Florian
> >
> > [1]
> > https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements
> >
> > Am Montag, dem 21.11.2022 um 19:53 +0100 schrieb Florian Micklich:
> >>
> >> Hi all,<br>
> >>
> >> I saw now two difference License headers in the code. What Option is
> >> correct? ( I know it is only a minor issue because it is only the
> >> format)<br>
> >>
> >> Option 1<br>
> >> ```<br>
> >> /*<br>
> >> * Licensed to the Apache Software Foundation (ASF) under one or
> >> more<br>
> >> * contributor license agreements. See the NOTICE file distributed
> >> with<br>
> >> * this work for additional information regarding copyright
> >> ownership.<br>
> >> * The ASF licenses this file to You under the Apache License,
> >> Version 2.0<br>
> >> * (the "License"); you may not use this file except in compliance
> >> with<br>
> >> * the License. You may obtain a copy of the License at<br>
> >> *<br>
> >> *
> >> [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)<br<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%3cbr<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%3cbr%3chttp:/www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%3cbr>>>
> >> *<br>
> >> * Unless required by applicable law or agreed to in writing,
> >> software<br>
> >> * distributed under the License is distributed on an "AS IS"
> >> BASIS,<br>
> >> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
> >> implied.<br>
> >> * See the License for the specific language governing permissions
> >> and<br>
> >> * limitations under the License.<br>
> >> */<br>
> >> ```<br>
> >>
> >>
> >> Option 2<br>
> >> ```<br>
> >> /*<br>
> >> *<br>
> >> * * Licensed to the Apache Software Foundation (ASF) under one or
> >> more<br>
> >> * * contributor license agreements. See the NOTICE file distributed
> >> with<br>
> >> * * this work for additional information regarding copyright
> >> ownership.<br>
> >> * * The ASF licenses this file to You under the Apache License,
> >> Version 2.0<br>
> >> * * (the "License"); you may not use this file except in compliance
> >> with<br>
> >> * * the License. You may obtain a copy of the License at<br>
> >> * *<br>
> >> * *
> >> [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)<br<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%3cbr<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%3cbr%3chttp:/www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%3cbr>>>
> >> * *<br>
> >> * * Unless required by applicable law or agreed to in writing,
> >> software<br>
> >> * * distributed under the License is distributed on an "AS IS"
> >> BASIS,<br>
> >> * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
> >> implied.<br>
> >> * * See the License for the specific language governing permissions
> >> and<br>
> >> * * limitations under the License.<br>
> >> * *<br>
> >> *<br>
> >> */<br>
> >> ```<br>
> >>
> >>
> >> In markdown this is used. I will add the description here [1] that for
> >> markdown another profile has to be used.<br>
> >> ```<br>
> >> #<br>
> >> # Licensed to the Apache Software Foundation (ASF) under one or
> >> more<br>
> >> # contributor license agreements. See the NOTICE file distributed
> >> with<br>
> >> # this work for additional information regarding copyright
> >> ownership.<br>
> >> # The ASF licenses this file to You under the Apache License, Version
> >> 2.0<br>
> >> # (the "License"); you may not use this file except in compliance
> >> with<br>
> >> # the License. You may obtain a copy of the License at<br>
> >> #<br>
> >> #
> >> [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)<br<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%3cbr<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%3cbr%3chttp:/www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%3cbr>>>
> >> #<br>
> >> # Unless required by applicable law or agreed to in writing,
> >> software<br>
> >> # distributed under the License is distributed on an "AS IS"
> >> BASIS,<br>
> >> # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
> >> implied.<br>
> >> # See the License for the specific language governing permissions
> >> and<br>
> >> # limitations under the License.<br>
> >> #<br>
> >> ```<br>
> >>
> >> Greetings<br>
> >> Florian<br>
> >>
> >> [1]
> >> [https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)<br<https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements%5d(https:/cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)%3cbr<https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements%5d(https:/cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)%3cbr%3chttps:/cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements%5d(https:/cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)%3cbr>>>
>
Re: Apache License Header Format
Posted by Dominik Riemer <ri...@apache.org>.
Hi,
just to summarize the outcome of this discussion:
* We prefer option 1 for license header styling
* Having automated checks for license headers in form of checkstyle config or pre-commit hooks is great. Just a side note, it is generally possible to have other non-ASF license headers in our code when integrating 3rd party code (e.g., MIT, but these files must be explicitly mentioned in the LICENSE file).
* License headers itself should never be added automatically as it is our responsibility to make sure correct licenses are used.
Cheers
Dominik
On 2022/11/24 20:14:19 Christofer Dutz wrote:
> Hi all,
>
> Automatically sticking Apache Headers to code isn’t a good idea.
> If someone adds something that’s copied from somewhere else, we’re actually not allowed to add Apache headers to it.
>
> Chris
>
> From: Tim <bo...@posteo.de>
> Date: Tuesday, 22. November 2022 at 20:12
> To: dev@streampipes.apache.org <de...@streampipes.apache.org>
> Subject: Re: Apache License Header Format
> Hi Florian,
>
> no, there is yet no automation for Apache headers in resource files.
> That yould be a future improvement.
>
> Best
> Tim
>
> Am 22.11.2022 12:34 schrieb Florian Micklich:
> > Hi,
> >
> > I can answer my question by myself.
> > It is Option 1.
> >
> > Option 2 occurs on my side because of a "wrong" automatic Copyright
> > text.
> > IntelliJ is creating the commends syntax itself, that leads to option
> > 2. If you add the text already with comment syntax, the double comment
> > is the result.
> >
> > I added the info in conf [1]
> >
> > I think there is no option to make a different profile for markdown
> > files.
> > But this is done via STREAMPIPES-590 anyway automatically. Am I right?
> >
> > Greeting
> > Florian
> >
> > [1]
> > https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements
> >
> > Am Montag, dem 21.11.2022 um 19:53 +0100 schrieb Florian Micklich:
> >>
> >> Hi all,<br>
> >>
> >> I saw now two difference License headers in the code. What Option is
> >> correct? ( I know it is only a minor issue because it is only the
> >> format)<br>
> >>
> >> Option 1<br>
> >> ```<br>
> >> /*<br>
> >> * Licensed to the Apache Software Foundation (ASF) under one or
> >> more<br>
> >> * contributor license agreements. See the NOTICE file distributed
> >> with<br>
> >> * this work for additional information regarding copyright
> >> ownership.<br>
> >> * The ASF licenses this file to You under the Apache License,
> >> Version 2.0<br>
> >> * (the "License"); you may not use this file except in compliance
> >> with<br>
> >> * the License. You may obtain a copy of the License at<br>
> >> *<br>
> >> *
> >> [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)<br<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%3cbr>>
> >> *<br>
> >> * Unless required by applicable law or agreed to in writing,
> >> software<br>
> >> * distributed under the License is distributed on an "AS IS"
> >> BASIS,<br>
> >> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
> >> implied.<br>
> >> * See the License for the specific language governing permissions
> >> and<br>
> >> * limitations under the License.<br>
> >> */<br>
> >> ```<br>
> >>
> >>
> >> Option 2<br>
> >> ```<br>
> >> /*<br>
> >> *<br>
> >> * * Licensed to the Apache Software Foundation (ASF) under one or
> >> more<br>
> >> * * contributor license agreements. See the NOTICE file distributed
> >> with<br>
> >> * * this work for additional information regarding copyright
> >> ownership.<br>
> >> * * The ASF licenses this file to You under the Apache License,
> >> Version 2.0<br>
> >> * * (the "License"); you may not use this file except in compliance
> >> with<br>
> >> * * the License. You may obtain a copy of the License at<br>
> >> * *<br>
> >> * *
> >> [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)<br<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%3cbr>>
> >> * *<br>
> >> * * Unless required by applicable law or agreed to in writing,
> >> software<br>
> >> * * distributed under the License is distributed on an "AS IS"
> >> BASIS,<br>
> >> * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
> >> implied.<br>
> >> * * See the License for the specific language governing permissions
> >> and<br>
> >> * * limitations under the License.<br>
> >> * *<br>
> >> *<br>
> >> */<br>
> >> ```<br>
> >>
> >>
> >> In markdown this is used. I will add the description here [1] that for
> >> markdown another profile has to be used.<br>
> >> ```<br>
> >> #<br>
> >> # Licensed to the Apache Software Foundation (ASF) under one or
> >> more<br>
> >> # contributor license agreements. See the NOTICE file distributed
> >> with<br>
> >> # this work for additional information regarding copyright
> >> ownership.<br>
> >> # The ASF licenses this file to You under the Apache License, Version
> >> 2.0<br>
> >> # (the "License"); you may not use this file except in compliance
> >> with<br>
> >> # the License. You may obtain a copy of the License at<br>
> >> #<br>
> >> #
> >> [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)<br<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%3cbr>>
> >> #<br>
> >> # Unless required by applicable law or agreed to in writing,
> >> software<br>
> >> # distributed under the License is distributed on an "AS IS"
> >> BASIS,<br>
> >> # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
> >> implied.<br>
> >> # See the License for the specific language governing permissions
> >> and<br>
> >> # limitations under the License.<br>
> >> #<br>
> >> ```<br>
> >>
> >> Greetings<br>
> >> Florian<br>
> >>
> >> [1]
> >> [https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)<br<https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements%5d(https:/cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)%3cbr>>
>
Re: Apache License Header Format
Posted by Christofer Dutz <ch...@c-ware.de>.
Hi all,
Automatically sticking Apache Headers to code isn’t a good idea.
If someone adds something that’s copied from somewhere else, we’re actually not allowed to add Apache headers to it.
Chris
From: Tim <bo...@posteo.de>
Date: Tuesday, 22. November 2022 at 20:12
To: dev@streampipes.apache.org <de...@streampipes.apache.org>
Subject: Re: Apache License Header Format
Hi Florian,
no, there is yet no automation for Apache headers in resource files.
That yould be a future improvement.
Best
Tim
Am 22.11.2022 12:34 schrieb Florian Micklich:
> Hi,
>
> I can answer my question by myself.
> It is Option 1.
>
> Option 2 occurs on my side because of a "wrong" automatic Copyright
> text.
> IntelliJ is creating the commends syntax itself, that leads to option
> 2. If you add the text already with comment syntax, the double comment
> is the result.
>
> I added the info in conf [1]
>
> I think there is no option to make a different profile for markdown
> files.
> But this is done via STREAMPIPES-590 anyway automatically. Am I right?
>
> Greeting
> Florian
>
> [1]
> https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements
>
> Am Montag, dem 21.11.2022 um 19:53 +0100 schrieb Florian Micklich:
>>
>> Hi all,<br>
>>
>> I saw now two difference License headers in the code. What Option is
>> correct? ( I know it is only a minor issue because it is only the
>> format)<br>
>>
>> Option 1<br>
>> ```<br>
>> /*<br>
>> * Licensed to the Apache Software Foundation (ASF) under one or
>> more<br>
>> * contributor license agreements. See the NOTICE file distributed
>> with<br>
>> * this work for additional information regarding copyright
>> ownership.<br>
>> * The ASF licenses this file to You under the Apache License,
>> Version 2.0<br>
>> * (the "License"); you may not use this file except in compliance
>> with<br>
>> * the License. You may obtain a copy of the License at<br>
>> *<br>
>> *
>> [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)<br<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%3cbr>>
>> *<br>
>> * Unless required by applicable law or agreed to in writing,
>> software<br>
>> * distributed under the License is distributed on an "AS IS"
>> BASIS,<br>
>> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
>> implied.<br>
>> * See the License for the specific language governing permissions
>> and<br>
>> * limitations under the License.<br>
>> */<br>
>> ```<br>
>>
>>
>> Option 2<br>
>> ```<br>
>> /*<br>
>> *<br>
>> * * Licensed to the Apache Software Foundation (ASF) under one or
>> more<br>
>> * * contributor license agreements. See the NOTICE file distributed
>> with<br>
>> * * this work for additional information regarding copyright
>> ownership.<br>
>> * * The ASF licenses this file to You under the Apache License,
>> Version 2.0<br>
>> * * (the "License"); you may not use this file except in compliance
>> with<br>
>> * * the License. You may obtain a copy of the License at<br>
>> * *<br>
>> * *
>> [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)<br<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%3cbr>>
>> * *<br>
>> * * Unless required by applicable law or agreed to in writing,
>> software<br>
>> * * distributed under the License is distributed on an "AS IS"
>> BASIS,<br>
>> * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
>> implied.<br>
>> * * See the License for the specific language governing permissions
>> and<br>
>> * * limitations under the License.<br>
>> * *<br>
>> *<br>
>> */<br>
>> ```<br>
>>
>>
>> In markdown this is used. I will add the description here [1] that for
>> markdown another profile has to be used.<br>
>> ```<br>
>> #<br>
>> # Licensed to the Apache Software Foundation (ASF) under one or
>> more<br>
>> # contributor license agreements. See the NOTICE file distributed
>> with<br>
>> # this work for additional information regarding copyright
>> ownership.<br>
>> # The ASF licenses this file to You under the Apache License, Version
>> 2.0<br>
>> # (the "License"); you may not use this file except in compliance
>> with<br>
>> # the License. You may obtain a copy of the License at<br>
>> #<br>
>> #
>> [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)<br<http://www.apache.org/licenses/LICENSE-2.0%5d(http:/www.apache.org/licenses/LICENSE-2.0)%3cbr>>
>> #<br>
>> # Unless required by applicable law or agreed to in writing,
>> software<br>
>> # distributed under the License is distributed on an "AS IS"
>> BASIS,<br>
>> # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
>> implied.<br>
>> # See the License for the specific language governing permissions
>> and<br>
>> # limitations under the License.<br>
>> #<br>
>> ```<br>
>>
>> Greetings<br>
>> Florian<br>
>>
>> [1]
>> [https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)<br<https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements%5d(https:/cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)%3cbr>>
Re: Apache License Header Format
Posted by Tim <bo...@posteo.de>.
Hi Florian,
no, there is yet no automation for Apache headers in resource files.
That yould be a future improvement.
Best
Tim
Am 22.11.2022 12:34 schrieb Florian Micklich:
> Hi,
>
> I can answer my question by myself.
> It is Option 1.
>
> Option 2 occurs on my side because of a "wrong" automatic Copyright
> text.
> IntelliJ is creating the commends syntax itself, that leads to option
> 2. If you add the text already with comment syntax, the double comment
> is the result.
>
> I added the info in conf [1]
>
> I think there is no option to make a different profile for markdown
> files.
> But this is done via STREAMPIPES-590 anyway automatically. Am I right?
>
> Greeting
> Florian
>
> [1]
> https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements
>
> Am Montag, dem 21.11.2022 um 19:53 +0100 schrieb Florian Micklich:
>>
>> Hi all,<br>
>>
>> I saw now two difference License headers in the code. What Option is
>> correct? ( I know it is only a minor issue because it is only the
>> format)<br>
>>
>> Option 1<br>
>> ```<br>
>> /*<br>
>> * Licensed to the Apache Software Foundation (ASF) under one or
>> more<br>
>> * contributor license agreements. See the NOTICE file distributed
>> with<br>
>> * this work for additional information regarding copyright
>> ownership.<br>
>> * The ASF licenses this file to You under the Apache License,
>> Version 2.0<br>
>> * (the "License"); you may not use this file except in compliance
>> with<br>
>> * the License. You may obtain a copy of the License at<br>
>> *<br>
>> *
>> [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)<br>
>> *<br>
>> * Unless required by applicable law or agreed to in writing,
>> software<br>
>> * distributed under the License is distributed on an "AS IS"
>> BASIS,<br>
>> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
>> implied.<br>
>> * See the License for the specific language governing permissions
>> and<br>
>> * limitations under the License.<br>
>> */<br>
>> ```<br>
>>
>>
>> Option 2<br>
>> ```<br>
>> /*<br>
>> *<br>
>> * * Licensed to the Apache Software Foundation (ASF) under one or
>> more<br>
>> * * contributor license agreements. See the NOTICE file distributed
>> with<br>
>> * * this work for additional information regarding copyright
>> ownership.<br>
>> * * The ASF licenses this file to You under the Apache License,
>> Version 2.0<br>
>> * * (the "License"); you may not use this file except in compliance
>> with<br>
>> * * the License. You may obtain a copy of the License at<br>
>> * *<br>
>> * *
>> [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)<br>
>> * *<br>
>> * * Unless required by applicable law or agreed to in writing,
>> software<br>
>> * * distributed under the License is distributed on an "AS IS"
>> BASIS,<br>
>> * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
>> implied.<br>
>> * * See the License for the specific language governing permissions
>> and<br>
>> * * limitations under the License.<br>
>> * *<br>
>> *<br>
>> */<br>
>> ```<br>
>>
>>
>> In markdown this is used. I will add the description here [1] that for
>> markdown another profile has to be used.<br>
>> ```<br>
>> #<br>
>> # Licensed to the Apache Software Foundation (ASF) under one or
>> more<br>
>> # contributor license agreements. See the NOTICE file distributed
>> with<br>
>> # this work for additional information regarding copyright
>> ownership.<br>
>> # The ASF licenses this file to You under the Apache License, Version
>> 2.0<br>
>> # (the "License"); you may not use this file except in compliance
>> with<br>
>> # the License. You may obtain a copy of the License at<br>
>> #<br>
>> #
>> [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)<br>
>> #<br>
>> # Unless required by applicable law or agreed to in writing,
>> software<br>
>> # distributed under the License is distributed on an "AS IS"
>> BASIS,<br>
>> # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
>> implied.<br>
>> # See the License for the specific language governing permissions
>> and<br>
>> # limitations under the License.<br>
>> #<br>
>> ```<br>
>>
>> Greetings<br>
>> Florian<br>
>>
>> [1]
>> [https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)<br>
Re: Apache License Header Format
Posted by Xin Wang <da...@gmail.com>.
+1 for Option 1.
Florian Micklich <mi...@apache.org> 于2022年11月22日周二 19:35写道：
> Hi,
>
> I can answer my question by myself.
> It is Option 1.
>
> Option 2 occurs on my side because of a "wrong" automatic Copyright text.
> IntelliJ is creating the commends syntax itself, that leads to option 2.
> If you add the text already with comment syntax, the double comment is the
> result.
>
> I added the info in conf [1]
>
> I think there is no option to make a different profile for markdown files.
> But this is done via STREAMPIPES-590 anyway automatically. Am I right?
>
> Greeting
> Florian
>
> [1]
> https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements
>
> Am Montag, dem 21.11.2022 um 19:53 +0100 schrieb Florian Micklich:
> >
> > Hi all,<br>
> >
> > I saw now two difference License headers in the code. What Option is
> correct? ( I know it is only a minor issue because it is only the
> format)<br>
> >
> > Option 1<br>
> > ```<br>
> > /*<br>
> > * Licensed to the Apache Software Foundation (ASF) under one or
> more<br>
> > * contributor license agreements. See the NOTICE file distributed
> with<br>
> > * this work for additional information regarding copyright
> ownership.<br>
> > * The ASF licenses this file to You under the Apache License, Version
> 2.0<br>
> > * (the "License"); you may not use this file except in compliance
> with<br>
> > * the License. You may obtain a copy of the License at<br>
> > *<br>
> > * [
> http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
> <br>
> > *<br>
> > * Unless required by applicable law or agreed to in writing,
> software<br>
> > * distributed under the License is distributed on an "AS IS"
> BASIS,<br>
> > * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
> implied.<br>
> > * See the License for the specific language governing permissions
> and<br>
> > * limitations under the License.<br>
> > */<br>
> > ```<br>
> >
> >
> > Option 2<br>
> > ```<br>
> > /*<br>
> > *<br>
> > * * Licensed to the Apache Software Foundation (ASF) under one or
> more<br>
> > * * contributor license agreements. See the NOTICE file distributed
> with<br>
> > * * this work for additional information regarding copyright
> ownership.<br>
> > * * The ASF licenses this file to You under the Apache License,
> Version 2.0<br>
> > * * (the "License"); you may not use this file except in compliance
> with<br>
> > * * the License. You may obtain a copy of the License at<br>
> > * *<br>
> > * * [
> http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
> <br>
> > * *<br>
> > * * Unless required by applicable law or agreed to in writing,
> software<br>
> > * * distributed under the License is distributed on an "AS IS"
> BASIS,<br>
> > * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
> implied.<br>
> > * * See the License for the specific language governing permissions
> and<br>
> > * * limitations under the License.<br>
> > * *<br>
> > *<br>
> > */<br>
> > ```<br>
> >
> >
> > In markdown this is used. I will add the description here [1] that for
> markdown another profile has to be used.<br>
> > ```<br>
> > #<br>
> > # Licensed to the Apache Software Foundation (ASF) under one or more<br>
> > # contributor license agreements. See the NOTICE file distributed
> with<br>
> > # this work for additional information regarding copyright ownership.<br>
> > # The ASF licenses this file to You under the Apache License, Version
> 2.0<br>
> > # (the "License"); you may not use this file except in compliance
> with<br>
> > # the License. You may obtain a copy of the License at<br>
> > #<br>
> > # [
> http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
> <br>
> > #<br>
> > # Unless required by applicable law or agreed to in writing, software<br>
> > # distributed under the License is distributed on an "AS IS" BASIS,<br>
> > # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
> implied.<br>
> > # See the License for the specific language governing permissions and<br>
> > # limitations under the License.<br>
> > #<br>
> > ```<br>
> >
> > Greetings<br>
> > Florian<br>
> >
> > [1] [
> https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)
> <https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements%5D(https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)>
> <br>
>
--
Thanks,
Xin
Re: Apache License Header Format
Posted by Florian Micklich <mi...@apache.org>.
Hi,
I can answer my question by myself.
It is Option 1.
Option 2 occurs on my side because of a "wrong" automatic Copyright text.
IntelliJ is creating the commends syntax itself, that leads to option 2. If you add the text already with comment syntax, the double comment is the result.
I added the info in conf [1]
I think there is no option to make a different profile for markdown files.
But this is done via STREAMPIPES-590 anyway automatically. Am I right?
Greeting
Florian
[1] https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements
Am Montag, dem 21.11.2022 um 19:53 +0100 schrieb Florian Micklich:
>
> Hi all,<br>
>
> I saw now two difference License headers in the code. What Option is correct? ( I know it is only a minor issue because it is only the format)<br>
>
> Option 1<br>
> ```<br>
> /*<br>
> * Licensed to the Apache Software Foundation (ASF) under one or more<br>
> * contributor license agreements. See the NOTICE file distributed with<br>
> * this work for additional information regarding copyright ownership.<br>
> * The ASF licenses this file to You under the Apache License, Version 2.0<br>
> * (the "License"); you may not use this file except in compliance with<br>
> * the License. You may obtain a copy of the License at<br>
> *<br>
> * [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)<br>
> *<br>
> * Unless required by applicable law or agreed to in writing, software<br>
> * distributed under the License is distributed on an "AS IS" BASIS,<br>
> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br>
> * See the License for the specific language governing permissions and<br>
> * limitations under the License.<br>
> */<br>
> ```<br>
>
>
> Option 2<br>
> ```<br>
> /*<br>
> *<br>
> * * Licensed to the Apache Software Foundation (ASF) under one or more<br>
> * * contributor license agreements. See the NOTICE file distributed with<br>
> * * this work for additional information regarding copyright ownership.<br>
> * * The ASF licenses this file to You under the Apache License, Version 2.0<br>
> * * (the "License"); you may not use this file except in compliance with<br>
> * * the License. You may obtain a copy of the License at<br>
> * *<br>
> * * [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)<br>
> * *<br>
> * * Unless required by applicable law or agreed to in writing, software<br>
> * * distributed under the License is distributed on an "AS IS" BASIS,<br>
> * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br>
> * * See the License for the specific language governing permissions and<br>
> * * limitations under the License.<br>
> * *<br>
> *<br>
> */<br>
> ```<br>
>
>
> In markdown this is used. I will add the description here [1] that for markdown another profile has to be used.<br>
> ```<br>
> #<br>
> # Licensed to the Apache Software Foundation (ASF) under one or more<br>
> # contributor license agreements. See the NOTICE file distributed with<br>
> # this work for additional information regarding copyright ownership.<br>
> # The ASF licenses this file to You under the Apache License, Version 2.0<br>
> # (the "License"); you may not use this file except in compliance with<br>
> # the License. You may obtain a copy of the License at<br>
> #<br>
> # [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)<br>
> #<br>
> # Unless required by applicable law or agreed to in writing, software<br>
> # distributed under the License is distributed on an "AS IS" BASIS,<br>
> # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br>
> # See the License for the specific language governing permissions and<br>
> # limitations under the License.<br>
> #<br>
> ```<br>
>
> Greetings<br>
> Florian<br>
>
> [1] [https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements](https://cwiki.apache.org/confluence/display/STREAMPIPES/License+Requirements)<br>