You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@quickstep.apache.org by Zuyu Zhang <zu...@apache.org> on 2016/06/12 19:37:57 UTC
Guideline To Update Copyright Header
Hi,
I was wondering how to update copyright info in a file header to reflect
outside contributors' change.
More specifically, is it appropriate to add "Copyright 2016 The Apache
Quickstep Contributors."?
https://github.com/apache/incubator-quickstep/pull/27/files#diff-357f532831c389c757e7c87c7db1c4d3R4
Cheers,
Zuyu
Re: Guideline To Update Copyright Header
Posted by Jignesh Patel <ji...@pivotal.io>.
Hi Julian,
Good point. To clarify. I was only going to copy the copyright into the root NOTICE file, and leave the files completely untouched. So, they wouldn’t have the Apache header in the source files. Only our files would have the new Apache Copyright template.
Also, I think if it makes sense to the Quickstep mentors, and such a thing doesn’t exist, I’m happy to put together a document on what common tasks/problems that incubator community members face, and how to proactively pre-empt them. That may reduce the workload on the incubator mentors in the future. I do have a working scratch pad where I have been noting things and can clean them up in a few weeks when I think it will be clear that we have gotten past at least the first set of methods for doing things the ASF way. It will be a sequential checklist, so hopefully easy to follow, and hard to mess up.
Cheers,
Jignesh
> On Jun 15, 2016, at 1:15 PM, Julian Hyde <jh...@apache.org> wrote:
>
> If the code in third_party is merely “copied” into the project and not part of it, and in particular if have not forked it and intend to copy in a more recent version in the future, maybe you shouldn’t be applying Apache headers to those files. They could be just included in the source distribution (including appropriate licenses and notices).
>
> Other mentors, what do you think?
>
> Julian
Re: Guideline To Update Copyright Header
Posted by Julian Hyde <jh...@apache.org>.
If the code in third_party is merely “copied” into the project and not part of it, and in particular if have not forked it and intend to copy in a more recent version in the future, maybe you shouldn’t be applying Apache headers to those files. They could be just included in the source distribution (including appropriate licenses and notices).
Other mentors, what do you think?
Julian
> On Jun 14, 2016, at 4:08 PM, Jignesh Patel <ji...@pivotal.io> wrote:
>
> Following up on Roman’s excellent comment, I took all the copyright notices under third_party and collected them into a new NOTICE file (see below).
>
> Notice that there are comments within [Square Braces]. This will make it easier for us to update the NOTICE file if we chose to upgrade some of these third-party packages in the future.
>
> Also, the copyright file in the third_party/benchmark does not have year, so I simply reproduced it as they state in their AUTHORS file <https://github.com/apache/incubator-quickstep/blob/master/third_party/benchmark/AUTHORS>.
>
> Comments?
>
> Cheers,
> Jignesh
>
> Apache Quickstep (incubating)
> Copyright 2016 The Apache Software Foundation.
>
> This product includes software developed at
> The Apache Software Foundation (http://www.apache.org/).
>
> Portions Copyright (c) 2011-2015, Quickstep Technologies, LLC.
> Portions Copyright (c) 2015-2016, Pivotal Software, Inc.
>
> [Copyright for third_party/benchmark]
> Portions Copyright (c) Arne Beer <ar...@twobeer.de>
> Portions Copyright (c) Christopher Seymour <ch...@hotmail.com>
> Portions Copyright (c) David Coeurjolly <da...@liris.cnrs.fr>
> Portions Copyright (c) Dominic Hamon <dm...@stripysock.com>
> Portions Copyright (c) Eugene Zhuk <eu...@gmail.com>
> Portions Copyright (c) Evgeny Safronov <di...@gmail.com>
> Portions Copyright (c) Felix Homann <li...@showlabor.de>
> Portions Copyright (c) Google Inc.
> Portions Copyright (c) JianXiong Zhou <zh...@gmail.com>
> Portions Copyright (c) Lei Xu <ed...@gmail.com>
> Portions Copyright (c) Matt Clarkson <ma...@gmail.com>
> Portions Copyright (c) Oleksandr Sochka <sa...@gmail.com>
> Portions Copyright (c) Paul Redmond <pa...@gmail.com>
> Portions Copyright (c) Shuo Chen <ch...@chenshuo.com>
> Portions Copyright (c) Yusuke Suzuki <ut...@gmail.com>
>
> [Copyright for third_party/cpplint]
> Portions Copyright (c) 2009 Google Inc
>
> [Copyright for third_party/farmhash]
> Copyright (c) 2014 Google, Inc.
>
> [Copyright for third_party/gflags]
> Copyright (c) 2006, Google Inc.
>
> [Copyright for third_party/glog]
> Copyright (c) 2008, Google Inc.
>
> [Copyright for third_party/gpertools]
> Copyright (c) 2005, Google Inc.
>
> [Copyright for third_party/linenoise]
> Copyright (c) 2010-2014, Salvatore Sanfilippo <antirez at gmail dot com>
> Copyright (c) 2010-2013, Pieter Noordhuis <pcnoordhuis at gmail dot com>
Re: Guideline To Update Copyright Header
Posted by Jignesh Patel <ji...@pivotal.io>.
Following up on Roman’s excellent comment, I took all the copyright notices under third_party and collected them into a new NOTICE file (see below).
Notice that there are comments within [Square Braces]. This will make it easier for us to update the NOTICE file if we chose to upgrade some of these third-party packages in the future.
Also, the copyright file in the third_party/benchmark does not have year, so I simply reproduced it as they state in their AUTHORS file <https://github.com/apache/incubator-quickstep/blob/master/third_party/benchmark/AUTHORS>.
Comments?
Cheers,
Jignesh
Apache Quickstep (incubating)
Copyright 2016 The Apache Software Foundation.
This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).
Portions Copyright (c) 2011-2015, Quickstep Technologies, LLC.
Portions Copyright (c) 2015-2016, Pivotal Software, Inc.
[Copyright for third_party/benchmark]
Portions Copyright (c) Arne Beer <ar...@twobeer.de>
Portions Copyright (c) Christopher Seymour <ch...@hotmail.com>
Portions Copyright (c) David Coeurjolly <da...@liris.cnrs.fr>
Portions Copyright (c) Dominic Hamon <dm...@stripysock.com>
Portions Copyright (c) Eugene Zhuk <eu...@gmail.com>
Portions Copyright (c) Evgeny Safronov <di...@gmail.com>
Portions Copyright (c) Felix Homann <li...@showlabor.de>
Portions Copyright (c) Google Inc.
Portions Copyright (c) JianXiong Zhou <zh...@gmail.com>
Portions Copyright (c) Lei Xu <ed...@gmail.com>
Portions Copyright (c) Matt Clarkson <ma...@gmail.com>
Portions Copyright (c) Oleksandr Sochka <sa...@gmail.com>
Portions Copyright (c) Paul Redmond <pa...@gmail.com>
Portions Copyright (c) Shuo Chen <ch...@chenshuo.com>
Portions Copyright (c) Yusuke Suzuki <ut...@gmail.com>
[Copyright for third_party/cpplint]
Portions Copyright (c) 2009 Google Inc
[Copyright for third_party/farmhash]
Copyright (c) 2014 Google, Inc.
[Copyright for third_party/gflags]
Copyright (c) 2006, Google Inc.
[Copyright for third_party/glog]
Copyright (c) 2008, Google Inc.
[Copyright for third_party/gpertools]
Copyright (c) 2005, Google Inc.
[Copyright for third_party/linenoise]
Copyright (c) 2010-2014, Salvatore Sanfilippo <antirez at gmail dot com>
Copyright (c) 2010-2013, Pieter Noordhuis <pcnoordhuis at gmail dot com>
Re: Guideline To Update Copyright Header
Posted by Jignesh Patel <ji...@pivotal.io>.
Hi Roman:
Good point! Will fix and all the ones that we automatically include (and not the ones that are in submodules).
Cheers,
Jignesh
> On Jun 14, 2016, at 5:36 PM, Roman Shaposhnik <ro...@shaposhnik.org> wrote:
>
> Just make sure that you do the right thing with the files copyrighted
> by somebody other
> that Pivotal and Quickstep Technologies. For example, I definitely see
> Google and a few
> others in the codebase.
>
> Thanks,
> Roman.
>
> On Mon, Jun 13, 2016 at 4:41 PM, Jignesh Patel <ji...@pivotal.io> wrote:
>>> +1 to keeping the NOTICE file as short as possible. Some projects get into the habit of adding copyrights & notices merely out of “courtesy” but that imposes a burden on downstream projects (who are obliged by the ASL to pass on the NOTICE file intact).
>>>
>>> Julian
>>
>>
>> Thanks Julian for the feedback about how it is important for downstream projects! I hadn’t thought of that — and makes perfect sense. In that spirit, we strictly only need the first two lines, so will make the NOTICE file even simpler, and just be:
>>
>> Apache Quickstep (incubating)
>> Copyright 2016 The Apache Software Foundation.
>>
>> This product includes software developed at
>> The Apache Software Foundation (http://www.apache.org/ <http://www.apache.org/>).
>>
>> Portions Copyright (c) 2011-2015, Quickstep Technologies, LLC.
>> Portions Copyright (c) 2015-2016, Pivotal Software, Inc.
>>
>> Cheers,
>> Jignesh
Re: Guideline To Update Copyright Header
Posted by Roman Shaposhnik <ro...@shaposhnik.org>.
Just make sure that you do the right thing with the files copyrighted
by somebody other
that Pivotal and Quickstep Technologies. For example, I definitely see
Google and a few
others in the codebase.
Thanks,
Roman.
On Mon, Jun 13, 2016 at 4:41 PM, Jignesh Patel <ji...@pivotal.io> wrote:
>> +1 to keeping the NOTICE file as short as possible. Some projects get into the habit of adding copyrights & notices merely out of “courtesy” but that imposes a burden on downstream projects (who are obliged by the ASL to pass on the NOTICE file intact).
>>
>> Julian
>
>
> Thanks Julian for the feedback about how it is important for downstream projects! I hadn’t thought of that — and makes perfect sense. In that spirit, we strictly only need the first two lines, so will make the NOTICE file even simpler, and just be:
>
> Apache Quickstep (incubating)
> Copyright 2016 The Apache Software Foundation.
>
> This product includes software developed at
> The Apache Software Foundation (http://www.apache.org/ <http://www.apache.org/>).
>
> Portions Copyright (c) 2011-2015, Quickstep Technologies, LLC.
> Portions Copyright (c) 2015-2016, Pivotal Software, Inc.
>
> Cheers,
> Jignesh
Re: Guideline To Update Copyright Header
Posted by Jignesh Patel <ji...@pivotal.io>.
> +1 to keeping the NOTICE file as short as possible. Some projects get into the habit of adding copyrights & notices merely out of “courtesy” but that imposes a burden on downstream projects (who are obliged by the ASL to pass on the NOTICE file intact).
>
> Julian
Thanks Julian for the feedback about how it is important for downstream projects! I hadn’t thought of that — and makes perfect sense. In that spirit, we strictly only need the first two lines, so will make the NOTICE file even simpler, and just be:
Apache Quickstep (incubating)
Copyright 2016 The Apache Software Foundation.
This product includes software developed at
The Apache Software Foundation (http://www.apache.org/ <http://www.apache.org/>).
Portions Copyright (c) 2011-2015, Quickstep Technologies, LLC.
Portions Copyright (c) 2015-2016, Pivotal Software, Inc.
Cheers,
Jignesh
Re: Guideline To Update Copyright Header
Posted by Julian Hyde <jh...@apache.org>.
> On Jun 13, 2016, at 8:01 AM, Jignesh Patel <ji...@pivotal.io> wrote:
>
> Please note it is my understanding that we don’t need to add our individual names or organization names to the NOTICE file, so don’t need to grow the list in the NOTICE file.
+1 to keeping the NOTICE file as short as possible. Some projects get into the habit of adding copyrights & notices merely out of “courtesy” but that imposes a burden on downstream projects (who are obliged by the ASL to pass on the NOTICE file intact).
Julian
Re: Guideline To Update Copyright Header
Posted by Jignesh Patel <ji...@pivotal.io>.
Thanks Roman!
To not disturb the ongoing work in existing PRs, I can take care of fixing the copyright in all existing files once we have closed the existing PRs (upto PR #28) . I’ll write a sed script to make the switch. Tentatively, lets plan on running this script this on Thursday 6/16 at noon CT. Soon after that, hopefully it will be merged into the master.
/**
* 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.
**/
I’ll replace the existing NOTICE file in the root Quickstep directory that has the following contents tomorrow at June 14 at noon CT, so new files going in after that with the header above point to the right NOTICE file. For PRs being merged after the new NOTICE file is in the master, if you feel like you need to change the copyright notice (you don’t have to as I can take care of that when I run the sed script), please use the contents in the the copyright block above.
Apache Quickstep (incubating)
Copyright 2016 The Apache Software Foundation.
This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).
Portions Copyright (c) 2011-2015, Quickstep Technologies, LLC.
Portions Copyright (c) 2015-2016, Pivotal Software, Inc.
Portions Copyright (c) 2015-2016, Quickstep Research Group, University of Wisconsin-Madison.
Please note it is my understanding that we don’t need to add our individual names or organization names to the NOTICE file, so don’t need to grow the list in the NOTICE file.
Please let me know if you spot some errors in this approach.
Cheers,
Jignesh
> On Jun 12, 2016, at 5:38 PM, Roman Shaposhnik <ro...@shaposhnik.org> wrote:
>
> All of your copyright headers need to look exactly like this:
> http://www.apache.org/legal/src-headers.html#headers
>
> In fact, this will be one of the requirements on which your first
> ASF release will be predicated. All the other Copyright statements
> need to be coalesced and moved into the NOTICE file similar to:
> https://github.com/apache/incubator-hawq/blob/master/NOTICE
>
> Thanks,
> Roman.
>
> On Mon, Jun 13, 2016 at 12:25 AM, Jignesh M. Patel <ji...@pivotal.io> wrote:
>> Others can correct me if I have this wrong, but we should it add any additional copyright anymore. It's implicit that contributions are to Apache.
>>
>> This also means less work for committers and we can avoid requests during PR to update the copyright.
>>
>> I suggest dropping the copyright line in this PR.
>>
>> Thanks!
>>
>> Sent from my iPhone
>>
>>> On Jun 12, 2016, at 2:37 PM, Zuyu Zhang <zu...@apache.org> wrote:
>>>
>>> Hi,
>>>
>>> I was wondering how to update copyright info in a file header to reflect
>>> outside contributors' change.
>>>
>>> More specifically, is it appropriate to add "Copyright 2016 The Apache
>>> Quickstep Contributors."?
>>>
>>> https://github.com/apache/incubator-quickstep/pull/27/files#diff-357f532831c389c757e7c87c7db1c4d3R4
>>>
>>> Cheers,
>>> Zuyu
Re: Guideline To Update Copyright Header
Posted by Roman Shaposhnik <ro...@shaposhnik.org>.
All of your copyright headers need to look exactly like this:
http://www.apache.org/legal/src-headers.html#headers
In fact, this will be one of the requirements on which your first
ASF release will be predicated. All the other Copyright statements
need to be coalesced and moved into the NOTICE file similar to:
https://github.com/apache/incubator-hawq/blob/master/NOTICE
Thanks,
Roman.
On Mon, Jun 13, 2016 at 12:25 AM, Jignesh M. Patel <ji...@pivotal.io> wrote:
> Others can correct me if I have this wrong, but we should it add any additional copyright anymore. It's implicit that contributions are to Apache.
>
> This also means less work for committers and we can avoid requests during PR to update the copyright.
>
> I suggest dropping the copyright line in this PR.
>
> Thanks!
>
> Sent from my iPhone
>
>> On Jun 12, 2016, at 2:37 PM, Zuyu Zhang <zu...@apache.org> wrote:
>>
>> Hi,
>>
>> I was wondering how to update copyright info in a file header to reflect
>> outside contributors' change.
>>
>> More specifically, is it appropriate to add "Copyright 2016 The Apache
>> Quickstep Contributors."?
>>
>> https://github.com/apache/incubator-quickstep/pull/27/files#diff-357f532831c389c757e7c87c7db1c4d3R4
>>
>> Cheers,
>> Zuyu
Re: Guideline To Update Copyright Header
Posted by "Jignesh M. Patel" <ji...@pivotal.io>.
Others can correct me if I have this wrong, but we should it add any additional copyright anymore. It's implicit that contributions are to Apache.
This also means less work for committers and we can avoid requests during PR to update the copyright.
I suggest dropping the copyright line in this PR.
Thanks!
Sent from my iPhone
> On Jun 12, 2016, at 2:37 PM, Zuyu Zhang <zu...@apache.org> wrote:
>
> Hi,
>
> I was wondering how to update copyright info in a file header to reflect
> outside contributors' change.
>
> More specifically, is it appropriate to add "Copyright 2016 The Apache
> Quickstep Contributors."?
>
> https://github.com/apache/incubator-quickstep/pull/27/files#diff-357f532831c389c757e7c87c7db1c4d3R4
>
> Cheers,
> Zuyu