You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@shiro.apache.org by Les Hazlewood <le...@hazlewood.com> on 2008/06/27 17:22:14 UTC

IntelliJ Copyright plugin

Hi guys,

If you use Intellij (I think everyone on the team does), please download and
install the "Copyright" plugin.  It is great!  It allows you to set
different copyrights across projects or even modules.

I'm updating all source files in the JSecurity project to use the following
copyright header.  Please ensure you set up the same in your IDE.  The
benefit of this is that the plugin will update the whole project when there
is a new year - no more manually editing of each file to reflect a year
change (uses Velocity to substitute $today.year with the current value).
Don't add comments to it - the plugin will automatically create the
appropriate comment blocks depending on file type (e.g. java -> /* */, xml
-> <!-- -->, etc)

Copyright (C) 2004-$today.year, Apache Software Foundation or
third-party contributors as indicated by the @author tags or
express copyright attribution statements applied by the authors.
All third-party contributions are distributed under license by
the Apache Software Foundation.

Licensed 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.

Re: IntelliJ Copyright plugin

Posted by Tim Veil <tj...@gmail.com>.
I'm downloading now.  Is there a way you can export your configuration and
share?  I think you can with other similar configuration settings.

Tim

On Fri, Jun 27, 2008 at 11:22 AM, Les Hazlewood <le...@hazlewood.com> wrote:

> Hi guys,
>
> If you use Intellij (I think everyone on the team does), please download
> and
> install the "Copyright" plugin.  It is great!  It allows you to set
> different copyrights across projects or even modules.
>
> I'm updating all source files in the JSecurity project to use the following
> copyright header.  Please ensure you set up the same in your IDE.  The
> benefit of this is that the plugin will update the whole project when there
> is a new year - no more manually editing of each file to reflect a year
> change (uses Velocity to substitute $today.year with the current value).
> Don't add comments to it - the plugin will automatically create the
> appropriate comment blocks depending on file type (e.g. java -> /* */, xml
> -> <!-- -->, etc)
>
> Copyright (C) 2004-$today.year, Apache Software Foundation or
> third-party contributors as indicated by the @author tags or
> express copyright attribution statements applied by the authors.
> All third-party contributions are distributed under license by
> the Apache Software Foundation.
>
> Licensed 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.
>

Re: IntelliJ Copyright plugin

Posted by Emmanuel Lecharny <el...@apache.org>.
Sounds better.

I would also suggest two things :
- as not all of the future committers for JSecurity will use Intellij, 
it would be smart to provide a configurable set of files to setup such 
things for different IDEs (You can import a resource file in eclipse to 
do so).
- as it would be convenient for new committers to have these files, it 
would be good to store them in the repo.

Defining a common formating pattern would also be a good idea (java 
style, comments style, and so on ...)

Les Hazlewood wrote:
> Dangit.  You'd think I could read.  The third time's the charm!
>
> This is really what it is supposed to read (per the ASF website,
> http://www.apache.org/licenses/LICENSE-2.0.html):
>
> 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.
>
> Please disregard the previous emails.  Thanks!
>
> On Fri, Jun 27, 2008 at 11:26 AM, Les Hazlewood <le...@hazlewood.com> wrote:
>
>   
>> Oops, check that.  Please ensure it says the following:
>>
>> Copyright (C) 2004-$today.year, Apache Software Foundation under
>> one or more contributor license agreements.  See the NOTICE file
>> distributed with this work for additional information regarding
>> copyright ownership.
>>
>> Licensed 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.
>>
>>
>> On Fri, Jun 27, 2008 at 11:22 AM, Les Hazlewood <le...@hazlewood.com> wrote:
>>
>>     
>>> Hi guys,
>>>
>>> If you use Intellij (I think everyone on the team does), please download
>>> and install the "Copyright" plugin.  It is great!  It allows you to set
>>> different copyrights across projects or even modules.
>>>
>>> I'm updating all source files in the JSecurity project to use the
>>> following copyright header.  Please ensure you set up the same in your IDE.
>>> The benefit of this is that the plugin will update the whole project when
>>> there is a new year - no more manually editing of each file to reflect a
>>> year change (uses Velocity to substitute $today.year with the current
>>> value).  Don't add comments to it - the plugin will automatically create the
>>> appropriate comment blocks depending on file type (e.g. java -> /* */, xml
>>> -> <!-- -->, etc)
>>>
>>> Copyright (C) 2004-$today.year, Apache Software Foundation or
>>> third-party contributors as indicated by the @author tags or
>>> express copyright attribution statements applied by the authors.
>>> All third-party contributions are distributed under license by
>>> the Apache Software Foundation.
>>>
>>> Licensed 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.
>>>
>>>       
>>     
>
>   


-- 
--
cordialement, regards,
Emmanuel Lécharny
www.iktek.com
directory.apache.org



Re: IntelliJ Copyright plugin

Posted by Craig L Russell <Cr...@Sun.COM>.
On Jun 27, 2008, at 8:37 AM, Les Hazlewood wrote:

> Dangit.  You'd think I could read.  The third time's the charm!
>
> This is really what it is supposed to read (per the ASF website,
> http://www.apache.org/licenses/LICENSE-2.0.html):
>
> 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.
>
> Please disregard the previous emails.  Thanks!

Yup. The standard Apache v2 license should be used in all source  
files, including .xml, .java, .sh, basically all source formats that  
can tolerate comments. This requirement is waived for files that can't  
have comments, including stuff like .jpg, .pdf, .gif, etc.

Craig
>
>
> On Fri, Jun 27, 2008 at 11:26 AM, Les Hazlewood <le...@hazlewood.com>  
> wrote:
>
>> Oops, check that.  Please ensure it says the following:
>>
>> Copyright (C) 2004-$today.year, Apache Software Foundation under
>> one or more contributor license agreements.  See the NOTICE file
>> distributed with this work for additional information regarding
>> copyright ownership.
>>
>> Licensed 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.
>>
>>
>> On Fri, Jun 27, 2008 at 11:22 AM, Les Hazlewood <le...@hazlewood.com>  
>> wrote:
>>
>>> Hi guys,
>>>
>>> If you use Intellij (I think everyone on the team does), please  
>>> download
>>> and install the "Copyright" plugin.  It is great!  It allows you  
>>> to set
>>> different copyrights across projects or even modules.
>>>
>>> I'm updating all source files in the JSecurity project to use the
>>> following copyright header.  Please ensure you set up the same in  
>>> your IDE.
>>> The benefit of this is that the plugin will update the whole  
>>> project when
>>> there is a new year - no more manually editing of each file to  
>>> reflect a
>>> year change (uses Velocity to substitute $today.year with the  
>>> current
>>> value).  Don't add comments to it - the plugin will automatically  
>>> create the
>>> appropriate comment blocks depending on file type (e.g. java -> /*  
>>> */, xml
>>> -> <!-- -->, etc)
>>>
>>> Copyright (C) 2004-$today.year, Apache Software Foundation or
>>> third-party contributors as indicated by the @author tags or
>>> express copyright attribution statements applied by the authors.
>>> All third-party contributions are distributed under license by
>>> the Apache Software Foundation.
>>>
>>> Licensed 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.
>>>
>>
>>

Craig Russell
Architect, Sun Java Enterprise System http://java.sun.com/products/jdo
408 276-5638 mailto:Craig.Russell@sun.com
P.S. A good JDO? O, Gasp!


Re: IntelliJ Copyright plugin

Posted by Les Hazlewood <le...@hazlewood.com>.
Dangit.  You'd think I could read.  The third time's the charm!

This is really what it is supposed to read (per the ASF website,
http://www.apache.org/licenses/LICENSE-2.0.html):

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.

Please disregard the previous emails.  Thanks!

On Fri, Jun 27, 2008 at 11:26 AM, Les Hazlewood <le...@hazlewood.com> wrote:

> Oops, check that.  Please ensure it says the following:
>
> Copyright (C) 2004-$today.year, Apache Software Foundation under
> one or more contributor license agreements.  See the NOTICE file
> distributed with this work for additional information regarding
> copyright ownership.
>
> Licensed 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.
>
>
> On Fri, Jun 27, 2008 at 11:22 AM, Les Hazlewood <le...@hazlewood.com> wrote:
>
>> Hi guys,
>>
>> If you use Intellij (I think everyone on the team does), please download
>> and install the "Copyright" plugin.  It is great!  It allows you to set
>> different copyrights across projects or even modules.
>>
>> I'm updating all source files in the JSecurity project to use the
>> following copyright header.  Please ensure you set up the same in your IDE.
>> The benefit of this is that the plugin will update the whole project when
>> there is a new year - no more manually editing of each file to reflect a
>> year change (uses Velocity to substitute $today.year with the current
>> value).  Don't add comments to it - the plugin will automatically create the
>> appropriate comment blocks depending on file type (e.g. java -> /* */, xml
>> -> <!-- -->, etc)
>>
>> Copyright (C) 2004-$today.year, Apache Software Foundation or
>> third-party contributors as indicated by the @author tags or
>> express copyright attribution statements applied by the authors.
>> All third-party contributions are distributed under license by
>> the Apache Software Foundation.
>>
>> Licensed 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.
>>
>
>

Re: IntelliJ Copyright plugin

Posted by Les Hazlewood <le...@hazlewood.com>.
Oops, check that.  Please ensure it says the following:

Copyright (C) 2004-$today.year, Apache Software Foundation under
one or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information regarding
copyright ownership.

Licensed 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.

On Fri, Jun 27, 2008 at 11:22 AM, Les Hazlewood <le...@hazlewood.com> wrote:

> Hi guys,
>
> If you use Intellij (I think everyone on the team does), please download
> and install the "Copyright" plugin.  It is great!  It allows you to set
> different copyrights across projects or even modules.
>
> I'm updating all source files in the JSecurity project to use the following
> copyright header.  Please ensure you set up the same in your IDE.  The
> benefit of this is that the plugin will update the whole project when there
> is a new year - no more manually editing of each file to reflect a year
> change (uses Velocity to substitute $today.year with the current value).
> Don't add comments to it - the plugin will automatically create the
> appropriate comment blocks depending on file type (e.g. java -> /* */, xml
> -> <!-- -->, etc)
>
> Copyright (C) 2004-$today.year, Apache Software Foundation or
> third-party contributors as indicated by the @author tags or
> express copyright attribution statements applied by the authors.
> All third-party contributions are distributed under license by
> the Apache Software Foundation.
>
> Licensed 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.
>