You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@plc4x.apache.org by Christofer Dutz <ch...@c-ware.de> on 2021/07/02 17:02:17 UTC

[DISCUSS] Clean up the Apache Headers?

Hi all,

I have noticed that we seem to be degrading regarding to how nice our 
Apache Headers look. While they are all valid version, they quite often 
don't seem to look nice, in my opinion.

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

Sort of looks less pretty than this:

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

Doesn't matter which ones you prefer, I think they should at least all 
be the same. At least all files that work with "/*" ... "*/" comments.

If you agree, which ones would you prefer?

1) The first one and I think all should look that way
2) The one with the " * "in every line and I think all should look that way
3) I don't care and I think we shouldn't change it
4) I prefer yet another variant and all should look like that

Chris

Re: [DISCUSS] Clean up the Apache Headers?

Posted by Ben Hutcheson <be...@gmail.com>.
Or we don't manage the licenses manually?
https://github.com/apache/skywalking-eyes


On Sat, Jul 3, 2021 at 3:22 AM Christofer Dutz <ch...@c-ware.de>
wrote:

> Hi Thomas,
>
> I think the super short version doesn't work for apache projects. At least
> I've never seen that being used before in any apache project.
>
> Chris
>
> Holen Sie sich Outlook für Android<https://aka.ms/AAb9ysg>
>
> ________________________________
> From: Ben Hutcheson <be...@gmail.com>
> Sent: Saturday, July 3, 2021 1:45:50 AM
> To: dev@plc4x.apache.org <de...@plc4x.apache.org>; Thomas <
> frost.tj@protonmail.com>
> Subject: Re: [DISCUSS] Clean up the Apache Headers?
>
> +0 for SPDX,
> Don't know much about what benefits it provides but it seems simple enough
> to implement.
>
> As well as +0 for number 2.
>
> On Fri, Jul 2, 2021 at 5:16 PM Thomas <fr...@protonmail.com.invalid>
> wrote:
>
> > Hi,
> >
> > Not sure if its "allowed" but:
> >
> > /* SPDX-License-Identifier: Apache-2.0 */
> >
> > avoids spam and means less scrolling which is a define win.
> >
> > Sent with ProtonMail Secure Email.
> >
> > ‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐
> >
> > On Friday, July 2nd, 2021 at 19:27, Christofer Dutz <
> > christofer.dutz@c-ware.de> wrote:
> >
> > > Oh...
> > >
> > > Forgot to state that I would prefer Nr. 2
> > >
> > > Chris
> > >
> > > Holen Sie sich Outlook für Androidhttps://aka.ms/AAb9ysg
> > >
> > > From: Christofer Dutz christofer.dutz@c-ware.de
> > >
> > > Sent: Friday, July 2, 2021 7:02:17 PM
> > >
> > > To: dev@plc4x.apache.org dev@plc4x.apache.org
> > >
> > > Subject: [DISCUSS] Clean up the Apache Headers?
> > >
> > > Hi all,
> > >
> > > I have noticed that we seem to be degrading regarding to how nice our
> > >
> > > Apache Headers look. While they are all valid version, they quite often
> > >
> > > don't seem to look nice, in my opinion.
> > >
> > > /*
> > >
> > > 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.
> > >
> > > /
> > >
> > > Sort of looks less pretty than this:
> > >
> > > /
> > >
> > > -   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.
> > >
> > >     /
> > >
> > >     Doesn't matter which ones you prefer, I think they should at least
> > all
> > >
> > >     be the same. At least all files that work with "/" ... "*/"
> comments.
> > >
> > >     If you agree, which ones would you prefer?
> > >
> > > 1.  The first one and I think all should look that way
> > > 2.  The one with the " * "in every line and I think all should look
> that
> > way
> > > 3.  I don't care and I think we shouldn't change it
> > > 4.  I prefer yet another variant and all should look like that
> > >
> > >     Chris
> >
>

Re: [DISCUSS] Clean up the Apache Headers?

Posted by Christofer Dutz <ch...@c-ware.de>.
Hi Thomas,

I think the super short version doesn't work for apache projects. At least I've never seen that being used before in any apache project.

Chris

Holen Sie sich Outlook f��r Android<https://aka.ms/AAb9ysg>

________________________________
From: Ben Hutcheson <be...@gmail.com>
Sent: Saturday, July 3, 2021 1:45:50 AM
To: dev@plc4x.apache.org <de...@plc4x.apache.org>; Thomas <fr...@protonmail.com>
Subject: Re: [DISCUSS] Clean up the Apache Headers?

+0 for SPDX,
Don't know much about what benefits it provides but it seems simple enough
to implement.

As well as +0 for number 2.

On Fri, Jul 2, 2021 at 5:16 PM Thomas <fr...@protonmail.com.invalid>
wrote:

> Hi,
>
> Not sure if its "allowed" but:
>
> /* SPDX-License-Identifier: Apache-2.0 */
>
> avoids spam and means less scrolling which is a define win.
>
> Sent with ProtonMail Secure Email.
>
> �\�\�\�\�\�\�\ Original Message �\�\�\�\�\�\�\
>
> On Friday, July 2nd, 2021 at 19:27, Christofer Dutz <
> christofer.dutz@c-ware.de> wrote:
>
> > Oh...
> >
> > Forgot to state that I would prefer Nr. 2
> >
> > Chris
> >
> > Holen Sie sich Outlook f��r Androidhttps://aka.ms/AAb9ysg
> >
> > From: Christofer Dutz christofer.dutz@c-ware.de
> >
> > Sent: Friday, July 2, 2021 7:02:17 PM
> >
> > To: dev@plc4x.apache.org dev@plc4x.apache.org
> >
> > Subject: [DISCUSS] Clean up the Apache Headers?
> >
> > Hi all,
> >
> > I have noticed that we seem to be degrading regarding to how nice our
> >
> > Apache Headers look. While they are all valid version, they quite often
> >
> > don't seem to look nice, in my opinion.
> >
> > /*
> >
> > 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.
> >
> > /
> >
> > Sort of looks less pretty than this:
> >
> > /
> >
> > -   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.
> >
> >     /
> >
> >     Doesn't matter which ones you prefer, I think they should at least
> all
> >
> >     be the same. At least all files that work with "/" ... "*/" comments.
> >
> >     If you agree, which ones would you prefer?
> >
> > 1.  The first one and I think all should look that way
> > 2.  The one with the " * "in every line and I think all should look that
> way
> > 3.  I don't care and I think we shouldn't change it
> > 4.  I prefer yet another variant and all should look like that
> >
> >     Chris
>

Re: [DISCUSS] Clean up the Apache Headers?

Posted by Ben Hutcheson <be...@gmail.com>.
+0 for SPDX,
Don't know much about what benefits it provides but it seems simple enough
to implement.

As well as +0 for number 2.

On Fri, Jul 2, 2021 at 5:16 PM Thomas <fr...@protonmail.com.invalid>
wrote:

> Hi,
>
> Not sure if its "allowed" but:
>
> /* SPDX-License-Identifier: Apache-2.0 */
>
> avoids spam and means less scrolling which is a define win.
>
> Sent with ProtonMail Secure Email.
>
> ‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐
>
> On Friday, July 2nd, 2021 at 19:27, Christofer Dutz <
> christofer.dutz@c-ware.de> wrote:
>
> > Oh...
> >
> > Forgot to state that I would prefer Nr. 2
> >
> > Chris
> >
> > Holen Sie sich Outlook für Androidhttps://aka.ms/AAb9ysg
> >
> > From: Christofer Dutz christofer.dutz@c-ware.de
> >
> > Sent: Friday, July 2, 2021 7:02:17 PM
> >
> > To: dev@plc4x.apache.org dev@plc4x.apache.org
> >
> > Subject: [DISCUSS] Clean up the Apache Headers?
> >
> > Hi all,
> >
> > I have noticed that we seem to be degrading regarding to how nice our
> >
> > Apache Headers look. While they are all valid version, they quite often
> >
> > don't seem to look nice, in my opinion.
> >
> > /*
> >
> > 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.
> >
> > /
> >
> > Sort of looks less pretty than this:
> >
> > /
> >
> > -   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.
> >
> >     /
> >
> >     Doesn't matter which ones you prefer, I think they should at least
> all
> >
> >     be the same. At least all files that work with "/" ... "*/" comments.
> >
> >     If you agree, which ones would you prefer?
> >
> > 1.  The first one and I think all should look that way
> > 2.  The one with the " * "in every line and I think all should look that
> way
> > 3.  I don't care and I think we shouldn't change it
> > 4.  I prefer yet another variant and all should look like that
> >
> >     Chris
>

Re: [DISCUSS] Clean up the Apache Headers?

Posted by Thomas <fr...@protonmail.com.INVALID>.
Hi,

Not sure if its "allowed" but:

/* SPDX-License-Identifier: Apache-2.0 */

avoids spam and means less scrolling which is a define win.

Sent with ProtonMail Secure Email.

‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐

On Friday, July 2nd, 2021 at 19:27, Christofer Dutz <ch...@c-ware.de> wrote:

> Oh...
>
> Forgot to state that I would prefer Nr. 2
>
> Chris
>
> Holen Sie sich Outlook für Androidhttps://aka.ms/AAb9ysg
>
> From: Christofer Dutz christofer.dutz@c-ware.de
>
> Sent: Friday, July 2, 2021 7:02:17 PM
>
> To: dev@plc4x.apache.org dev@plc4x.apache.org
>
> Subject: [DISCUSS] Clean up the Apache Headers?
>
> Hi all,
>
> I have noticed that we seem to be degrading regarding to how nice our
>
> Apache Headers look. While they are all valid version, they quite often
>
> don't seem to look nice, in my opinion.
>
> /*
>
> 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.
>
> /
>
> Sort of looks less pretty than this:
>
> /
>
> -   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.
>
>     /
>
>     Doesn't matter which ones you prefer, I think they should at least all
>
>     be the same. At least all files that work with "/" ... "*/" comments.
>
>     If you agree, which ones would you prefer?
>
> 1.  The first one and I think all should look that way
> 2.  The one with the " * "in every line and I think all should look that way
> 3.  I don't care and I think we shouldn't change it
> 4.  I prefer yet another variant and all should look like that
>
>     Chris

Re: [DISCUSS] Clean up the Apache Headers?

Posted by Christofer Dutz <ch...@c-ware.de>.
Oh...

Forgot to state that I would prefer Nr. 2

Chris

Holen Sie sich Outlook für Android<https://aka.ms/AAb9ysg>

________________________________
From: Christofer Dutz <ch...@c-ware.de>
Sent: Friday, July 2, 2021 7:02:17 PM
To: dev@plc4x.apache.org <de...@plc4x.apache.org>
Subject: [DISCUSS] Clean up the Apache Headers?

Hi all,

I have noticed that we seem to be degrading regarding to how nice our
Apache Headers look. While they are all valid version, they quite often
don't seem to look nice, in my opinion.

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

Sort of looks less pretty than this:

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

Doesn't matter which ones you prefer, I think they should at least all
be the same. At least all files that work with "/*" ... "*/" comments.

If you agree, which ones would you prefer?

1) The first one and I think all should look that way
2) The one with the " * "in every line and I think all should look that way
3) I don't care and I think we shouldn't change it
4) I prefer yet another variant and all should look like that

Chris