drill-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (DRILL-6320) Don't Allow Javadoc comments for license headers
Date Wed, 11 Apr 2018 21:17:00 GMT

    [ https://issues.apache.org/jira/browse/DRILL-6320?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16434583#comment-16434583
] 

ASF GitHub Bot commented on DRILL-6320:
---------------------------------------

GitHub user ilooner opened a pull request:

    https://github.com/apache/drill/pull/1207

    DRILL-6320: Fixed License Headers

    There were several issues with license headers before this change:
    
    1. We used the apache-rat-plugin to check licenses which was not thread safe. So when
doing concurrent builds of submodules with `mvn -T 2C clean install` it could fail.
    2. The apache-rat-plugin did not check all files for licenses and did not provide a warning
for the files it skipped.
    3. It allows inconsistent formatting of license headers.
    4. It allowed license headers to be in java doc comments. This is problematic since we
don't want the license to be included in every documentation page when we decide to publish
java docs. Further more rat provided no way to configure the comment style allowed, so we
were forced to live with this.
    
    All of these issues were fixed by moving to the license-maven-plugin. I have reformatted
all the license headers and manually verified the headers on each file to make sure they are
correct. Now every file in the project is checked for a license except for some shell scripts
that do not have file extensions in their names. Also none of the license headers are in java
doc comments now!!!!

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/ilooner/drill DRILL-6320

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/drill/pull/1207.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #1207
    
----
commit 066fc4b58a3de4237fab4a597c67c948882fdcd2
Author: Timothy Farkas <timothyfarkas@...>
Date:   2018-04-11T00:27:45Z

    DRILL-6320: Switched from apache-rate-plugin to license-maven-plugin and disallowed javadoc
comments for license headers.

commit 5fcea57acd47e6d1acc956517c1d3499f84729b1
Author: Timothy Farkas <timothyfarkas@...>
Date:   2018-04-11T00:45:49Z

     - More fixes

commit d8704eea73294d5beab3b470e51f576e3c7f977f
Author: Timothy Farkas <timothyfarkas@...>
Date:   2018-04-11T00:49:25Z

     - Even more fixes

commit 6c4ba191ed9fc84d32ea72ecd6fbf3972ba1028d
Author: Timothy Farkas <timothyfarkas@...>
Date:   2018-04-11T19:32:57Z

     - fixed more licenses

commit 7274190b7314265a0d5ed293374069ca43b5611a
Author: Timothy Farkas <timothyfarkas@...>
Date:   2018-04-11T19:36:00Z

     - fix new line

commit 6d7227e3b7df66120ad1ca698986c0e49eb77b96
Author: Timothy Farkas <timothyfarkas@...>
Date:   2018-04-11T19:45:15Z

     - Put proper license headers in ftl files.

----


> Don't Allow Javadoc comments for license headers
> ------------------------------------------------
>
>                 Key: DRILL-6320
>                 URL: https://issues.apache.org/jira/browse/DRILL-6320
>             Project: Apache Drill
>          Issue Type: Improvement
>            Reporter: Timothy Farkas
>            Assignee: Timothy Farkas
>            Priority: Major
>
> Currently some license headers are in a javadoc comment instead of a normal comment.
This is not good since we don't want to include spurious license headers in java docs when
we publish them. The fix would be to change the rat plugin configuration to not allow java
doc comments.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message