You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Shai Erera (JIRA)" <ji...@apache.org> on 2016/02/03 16:35:39 UTC

[jira] [Updated] (LUCENE-7012) Change eclipse's "New Java Files" template to place the license header before the package declaration

     [ https://issues.apache.org/jira/browse/LUCENE-7012?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Shai Erera updated LUCENE-7012:
-------------------------------
    Attachment: LUCENE-7012.patch

Patch moves the header before the package declaration. Unfortunately the file contains a single line for all templates, so it's a bit difficult to note the change, therefore what I've done looks like this:

{noformat}
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
...
 */
${filecomment}
${package_declaration}

${typecomment}
${type_declaration}
{noformat}

Before it appeared after the $\{package_declaration\}.

> Change eclipse's "New Java Files" template to place the license header before the package declaration
> -----------------------------------------------------------------------------------------------------
>
>                 Key: LUCENE-7012
>                 URL: https://issues.apache.org/jira/browse/LUCENE-7012
>             Project: Lucene - Core
>          Issue Type: Improvement
>            Reporter: Shai Erera
>            Assignee: Shai Erera
>         Attachments: LUCENE-7012.patch
>
>
> Today the license header is placed after the package declaration. This results in inconsistency in our files. In some the license is put after the package and before the imports, in others it appears after the imports but before class declaration and in others it appears in the middle of the imports.
> Also, when you e.g. "Organize Imports" in eclipse, if the header is located in the middle of imports, it's sometimes completely removed from the file.
> This issue is about changing the "New Java Files" template in eclipse so that the license header is placed before the package declaration. This ensures that "Organize Imports" doesn't mess with it, as well for new files (created in eclipse), we will start getting some consistency.
> If we also want to handle all current files by moving the license header before the package, we can do so (I volunteer), but since it's a big change, will likely do it over multiple commits and no need for an issue. BTW, if anyone knows of a tool that can automate that, great. I found that Apache has a perl script but it seems to only fix the header to the new format, yet not moving it in the file.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org