MyFaces Core
  1. MyFaces Core
  2. MYFACES-1488

ASF Source Header and Copyright Notice Policy

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.1.5
    • Component/s: None
    • Labels:
      None

      Description

      All the ASF License headers in the source files need to be updated to remove the copyright notice as per the new policy:

      http://www.apache.org/legal/src-headers.html

      We could also run Robert Burrell Donkin's "RAT" (release audit tool) to see if anything else is missing

      http://code.google.com/p/arat/

      1. rat_results.zip
        627 kB
        Grant Smith
      2. shared-core.patch
        223 kB
        Paul Spencer

        Activity

        Manfred Geiler made changes -
        Status Resolved [ 5 ] Closed [ 6 ]
        Manfred Geiler made changes -
        Fix Version/s 1.1.5 [ 12312310 ]
        Fix Version/s 1.1.5-SNAPSHOT [ 12311960 ]
        Grant Smith made changes -
        Status Patch Available [ 10002 ] Resolved [ 5 ]
        Resolution Fixed [ 1 ]
        Hide
        Grant Smith added a comment -

        Headers and notice files have been updated. We'll open a new issue for the RAT analysis.

        Show
        Grant Smith added a comment - Headers and notice files have been updated. We'll open a new issue for the RAT analysis.
        Grant Smith made changes -
        Priority Blocker [ 1 ] Major [ 3 ]
        Hide
        Grant Smith added a comment -

        Downgrading from blocker. This issue should not hold back a release.

        Show
        Grant Smith added a comment - Downgrading from blocker. This issue should not hold back a release.
        Grant Smith made changes -
        Attachment rat_results.zip [ 12345238 ]
        Hide
        Grant Smith added a comment -

        Attached is a zip file containing the output of RAT as of this date.

        Show
        Grant Smith added a comment - Attached is a zip file containing the output of RAT as of this date.
        Hide
        Wendy Smoak added a comment -

        If it was developed at or contributed to the ASF, yes, it should have a license header. (Third party works get mentioned in the NOTICE file, but I imagine that's more of an issue in Tomahawk.)

        I'm not set up to run RAT yet, can you post the output somewhere so I can take a look?

        Show
        Wendy Smoak added a comment - If it was developed at or contributed to the ASF, yes, it should have a license header. (Third party works get mentioned in the NOTICE file, but I imagine that's more of an issue in Tomahawk.) I'm not set up to run RAT yet, can you post the output somewhere so I can take a look?
        Hide
        Grant Smith added a comment -

        I have applied the patch from MYFACES-1491. Then I ran RAT against current and was overwhelmed by the output. It is basically a fancy grep at the moment. It reports on every single non-binary file and states what it's licence (if any) is. We have hundreds and hundreds of .xml, .js files that dont have the ASL header. At this point I'm not sure what the next step should be. Do we have to include the ASL header on every single file ?

        Show
        Grant Smith added a comment - I have applied the patch from MYFACES-1491 . Then I ran RAT against current and was overwhelmed by the output. It is basically a fancy grep at the moment. It reports on every single non-binary file and states what it's licence (if any) is. We have hundreds and hundreds of .xml, .js files that dont have the ASL header. At this point I'm not sure what the next step should be. Do we have to include the ASL header on every single file ?
        Hide
        Paul Spencer added a comment -

        Glen,
        What is the status of your work on this issue?

        Paul Spencer

        Show
        Paul Spencer added a comment - Glen, What is the status of your work on this issue? Paul Spencer
        Hide
        Paul Spencer added a comment -

        Wendy,
        I have created an issue, https://issues.apache.org/jira/browse/MYFACES-1491, and attached a patch to resolve the issue.

        Paul Spencer

        Show
        Paul Spencer added a comment - Wendy, I have created an issue, https://issues.apache.org/jira/browse/MYFACES-1491 , and attached a patch to resolve the issue. Paul Spencer
        Hide
        Wendy Smoak added a comment -

        There is already a build-tools module with a checkstyle config file:
        http://svn.apache.org/repos/asf/myfaces/maven/trunk/build-tools/src/main/resources/org/apache/myfaces/checkstyle.xml

        The RegExp header there can be modified to match the new header.

        However, it doesn't look like the Checkstyle report is enabled. http://myfaces.apache.org/impl/project-reports.html

        Show
        Wendy Smoak added a comment - There is already a build-tools module with a checkstyle config file: http://svn.apache.org/repos/asf/myfaces/maven/trunk/build-tools/src/main/resources/org/apache/myfaces/checkstyle.xml The RegExp header there can be modified to match the new header. However, it doesn't look like the Checkstyle report is enabled. http://myfaces.apache.org/impl/project-reports.html
        Hide
        Paul Spencer added a comment -

        Grant,
        I was using the Checkstyle plugin to verify the file header matched the Apache license text when creating the patch submitted for this issue. I suspect this is a clean approach since it is integrated into the Maven build process. As an additional benefit, Checkstyle can also be used to detect other formatting issues, like unused imports...

        I had started looking into the "Multimodule Configuration" [1] as a way of doing the configuration in one place and using it in many modules. But I was waiting on feedback on the patch and mailing list post related to this issue.

        As to "what next".
        1) A new JIRA Issue should be create for implementing Checkstyle, RAT,...
        2) If you want to take the lead on this, it is OK with me. If you want me to take the lead, I will but I will be dependent on a MyFaces committer since I am not one.

        Paul Spencer

        [1] http://maven.apache.org/plugins/maven-checkstyle-plugin/examples/multi-module-config.html

        Show
        Paul Spencer added a comment - Grant, I was using the Checkstyle plugin to verify the file header matched the Apache license text when creating the patch submitted for this issue. I suspect this is a clean approach since it is integrated into the Maven build process. As an additional benefit, Checkstyle can also be used to detect other formatting issues, like unused imports... I had started looking into the "Multimodule Configuration" [1] as a way of doing the configuration in one place and using it in many modules. But I was waiting on feedback on the patch and mailing list post related to this issue. As to "what next". 1) A new JIRA Issue should be create for implementing Checkstyle, RAT,... 2) If you want to take the lead on this, it is OK with me. If you want me to take the lead, I will but I will be dependent on a MyFaces committer since I am not one. Paul Spencer [1] http://maven.apache.org/plugins/maven-checkstyle-plugin/examples/multi-module-config.html
        Hide
        Grant Smith added a comment -

        I think I got them all. I didnt have time to look at RAT though; maybe that will find something else. Paul, if you like (and have time) you can test RAT on the Myfaces sources. Otherwise I'll try get to that later in the week

        Show
        Grant Smith added a comment - I think I got them all. I didnt have time to look at RAT though; maybe that will find something else. Paul, if you like (and have time) you can test RAT on the Myfaces sources. Otherwise I'll try get to that later in the week
        Hide
        Paul Spencer added a comment -

        Grant,

        Is their anything you need from me?

        Paul Spencer

        Show
        Paul Spencer added a comment - Grant, Is their anything you need from me? Paul Spencer
        Hide
        Grant Smith added a comment -

        I've started replacing all the headers. Should be completed today.

        Show
        Grant Smith added a comment - I've started replacing all the headers. Should be completed today.
        Grant Smith made changes -
        Assignee Grant Smith [ grantsmith ]
        Paul Spencer made changes -
        Attachment shared-core.patch [ 12344509 ]
        Hide
        Paul Spencer added a comment -

        Patch is to shared-core. I updates the license header in java source, java test, and resouce files.

        Show
        Paul Spencer added a comment - Patch is to shared-core. I updates the license header in java source, java test, and resouce files.
        Paul Spencer made changes -
        Field Original Value New Value
        Status Open [ 1 ] Patch Available [ 10002 ]
        Wendy Smoak created issue -

          People

          • Assignee:
            Grant Smith
            Reporter:
            Wendy Smoak
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development