This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 116037

Summary: license template: assumption about support for block comments
Product: projects Reporter: Marian Petras <mpetras>
Component: Generic Projects UIAssignee: Milan Kubec <mkubec>
Status: VERIFIED FIXED    
Severity: blocker CC: issues, jpokorsky
Priority: P4 Keywords: SIMPLEFIX
Version: 6.x   
Hardware: All   
OS: All   
Issue Type: DEFECT Exception Reporter:
Bug Depends on:    
Bug Blocks: 116034    
Attachments: suggested patch

Description Marian Petras 2007-09-19 16:41:13 UTC
The default license template file has format

   ${licenseFirst}
   ...
   ...
   ${licenselast}   

that is, it requires that FreeMarker variables "licenseFirst" and "licenseLast" are defined.

I believe this format was made with an idea of block comments (in Java, HTML, JSP, etc.) in mind. However, not all
languages and file formats support block comments - for example, .properties files do not support block comments. So
what value should be set to "licenseFirst" and "licenseLast"? Empty string! But that leads to empty lines in place of
${licenseFirst} and ${licenseLast}. I suggest that the license templates are changed such that "licenseFirst" and
"licenseLast" are not required:

   <#if licenseFirst??>
   ${licenseFirst}
   </#if>
   ...
   ...
   <#if licenseLast??>
   ${licenseLast}
   </#if>

This should be made into NetBeans 6.0 (until people develop their own license files based on the default ones).
Comment 1 Marian Petras 2007-09-19 16:41:55 UTC
Created attachment 49087 [details]
suggested patch
Comment 2 Milan Kubec 2007-09-21 10:45:31 UTC
Makes sense, although I think that licenseFirst and licenseLast can be set to '#' in case of properties files. 

Adding jpokorsky to CC to comment on this - was it meant as a start and end of block comment? Thanks.

If we agree on the fix I will integrate it even when it's set to correct priority, which is IMO P4. Thanks for
understanding.
Comment 3 Jan Pokorsky 2007-09-21 14:32:28 UTC
Not necessary a block comment but as a header and footer too. The proposed patch makes it even more customizable and it
is compatible. So +1 from me.

Please update also
apisupport/project/src/org/netbeans/modules/apisupport/project/ui/resources/license-cddl-netbeans-sun.txt the same way.
Comment 4 Marian Petras 2007-09-21 14:44:28 UTC
license-cddl-netbeans-sun.txt is already modified (see issue #116035).
Comment 5 Jan Pokorsky 2007-09-21 14:55:58 UTC
great
Comment 6 Milan Kubec 2007-09-21 16:13:56 UTC
Patch applied. Thanks.

Checking in license-default.txt;
/cvs/projects/projectui/src/org/netbeans/modules/project/ui/resources/license-default.txt,v  <--  license-default.txt
new revision: 1.4; previous revision: 1.3
done
Comment 7 Marian Petras 2007-09-21 16:58:45 UTC
Verified.

Thanks.