Lucene - Core
  1. Lucene - Core
  2. LUCENE-3949

Fix license headers in all Java files to not be in Javadocs /** format

    Details

    • Type: Task Task
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 4.0-ALPHA
    • Component/s: None
    • Labels:
      None
    • Lucene Fields:
      New

      Description

      Our current License headers in all .java files are (for a reason I don't know) in Javadocs format. Means, when you have a class without javadocs, the License header is used as Javadocs.

      I reviewed lots of other Apache projects, most of them use the correct /* header, but some (including Lucene+Solr) the Javadocs one. We should change this.

      1. LUCENE-3949.patch
        2.04 MB
        Hoss Man
      2. fix-license-jdoc.pl
        0.8 kB
        Hoss Man

        Activity

        Hide
        Hoss Man added a comment -

        Committed revision 1348980. - trunk
        Committed revision 1348984. - 4x

        Show
        Hoss Man added a comment - Committed revision 1348980. - trunk Committed revision 1348984. - 4x
        Hide
        Robert Muir added a comment -

        yes, I agree. I would re-run the script on 4.x branch (it has more files, e.g. preflex codec) and then just mark the rev merged with svn merge --record-only

        Show
        Robert Muir added a comment - yes, I agree. I would re-run the script on 4.x branch (it has more files, e.g. preflex codec) and then just mark the rev merged with svn merge --record-only
        Hide
        Uwe Schindler added a comment -

        ...and backport (means not merging, but applying the script in 4.x branch, too)

        Show
        Uwe Schindler added a comment - ...and backport (means not merging, but applying the script in 4.x branch, too)
        Hide
        Uwe Schindler added a comment -

        Commit this! Thanks!

        Show
        Uwe Schindler added a comment - Commit this! Thanks!
        Hide
        Hoss Man added a comment -

        Here's a script to mass fix everything, and the monster patch file it produces on trunk. (3350 files modified!)

        i haven't read the entire patch file but all the code & javadocs build cleanly, and (so far) the test are running fine.

        Any objections to committing this on trunk and then svn merging back to 4x?

        Show
        Hoss Man added a comment - Here's a script to mass fix everything, and the monster patch file it produces on trunk. (3350 files modified!) i haven't read the entire patch file but all the code & javadocs build cleanly, and (so far) the test are running fine. Any objections to committing this on trunk and then svn merging back to 4x?
        Hide
        Robert Muir added a comment -

        I committed detection for the situation where 'javadocs is a license header' in r1331787.

        These can be found with 'javadocs-lint' if you change it to "level=class" in lucene/build.xml

        But of course there are classes also missing class javadocs completely to fix too so
        we can't yet kick it on in hudson...

        Show
        Robert Muir added a comment - I committed detection for the situation where 'javadocs is a license header' in r1331787. These can be found with 'javadocs-lint' if you change it to "level=class" in lucene/build.xml But of course there are classes also missing class javadocs completely to fix too so we can't yet kick it on in hudson...

          People

          • Assignee:
            Hoss Man
            Reporter:
            Uwe Schindler
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development