brooklyn-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Alex Heneveld <>
Subject Re: license headers and config section
Date Fri, 19 Sep 2014 08:03:17 GMT

David-  Thanks.

Chip, mentors-  Appreciate your thoughts.

The issue is that many of the HTML files are templates.  Many are just 
one-line.  They'll be included hundreds of times, or thousands if it's a 
big (in-memory) table when pages are rendered.  So it has significant 
performance and memory impact.

It is only those templates which have had the header removed.  All the 
base HTML files include the header.

I don't know if it makes a difference but these template files are not 
in the distributables directly (wrt the condition that "human readable 
files in the distribution); they are only inside the WAR inside the 
distributable and there is already a LICENSE inside the WAR.

Given the above would this be alright?  Or if not can you suggest how 
other projects resolve this?


On 19/09/2014 07:06, David Nalley wrote:
> Hi Alex,
> So expect this to be challenged when your first release hits the IPMC
> (or even when mentors are reviewing code)
> Specifically, saving space or bandwidth isn't a good justification for
> not having a license header; from a policy perspective. There have
> been discussions in the past about using a shorter license header -
> but I'd argue that it's probably not in the best interest of folks
> trying to get a podlings first release out to engage on that issue.
> Chip; or other mentors - anyone feel I am off base here?
> --David
> On Wed, Sep 17, 2014 at 5:17 AM, Alex Heneveld
> <> wrote:
>> Hi folks,
>> I've prepared a PR #169 which removes the license headers from the YAML
>> blueprints, as discussed.  The reason was that these are used as examples,
>> often cutting and pasting, and having the license really gets in the way at
>> runtime.  (You can't see the blueprint when you paste the YAML into the GUI,
>> all you see are the headers!)
>> I've also remove it from most of the HTML source pages:  I don't think we
>> realized the implication of putting them there -- since most of the HTML
>> pages are templates, the license header ends up included in the resulting
>> HTML hundreds of times!  This bloats the pages and slows down processing.
>> The header is still included in the root index.html which is used for every
>> page -- so it appears in every page at runtime.  It is also in every CSS and
>> JS, where the optimizer can remove it so there is no runtime impact.
>> I think this is the best compromise but of course if there is guidance to
>> the contrary we can reconsider.
>> I have also moved the config section to the summary tab, to try that out.
>> [#168]
>> Best
>> Alex
>> [#169]
>> [#168]

View raw message