You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ofbiz.apache.org by Jacques Le Roux <ja...@les7arts.com> on 2019/09/03 14:10:58 UTC

Re: ASL2 header for meta-data files

Hi Mathieu,

Le 03/09/2019 à 15:32, Mathieu Lirzin a écrit :
> Hello Jacques,
>
>
>> Le 26/08/2019 à 13:47, Jacques Le Roux a écrit :
>>> If we need the stuff like
>>>
>>>     org.apache.ofbiz.base.util.test.UtilObjectTests$TestFactoryIntf
>>>
>>> Then this one misses an ASL2 header
>>>
>>> I was also wondering how they are updated, when compiling? If so how is the ASL2 header added?
> Those files are meta-data files that are maintained manually. They are
> distributed inside the JAR to allow the ‘ServiceLoader’ API [1] to find
> the classes implementing a particular interface (corresponding to the
> file name) efficiently.
> [1]https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html
>
> According to the specification, those files can include comments using
> the # character so technically we could add the ASL2 header, however I
> am not sure if we should/must copyright them.
>
> What are the recommandation of the ASF regarding meta-data or
> configuration files?

Reading https://www.apache.org/legal/src-headers.html#faq-siteindocs and sequel, specifically:

    /"If in doubt about the extent of the file's creativity, add the license header to the file."/

It seems to me that all these files should have an ASL2 header.
All similar others have it so I guess it's easier to put it in this one and go ahead. Else we would need to put these files as exceptions in

https://svn.apache.org/repos/asf/ofbiz/tools/rat-excludes.txt

HTH

Jacques
//


Re: ASL2 header for meta-data files

Posted by Mathieu Lirzin <ma...@nereide.fr>.
Jacques Le Roux <ja...@les7arts.com> writes:

> Le 03/09/2019 à 17:28, Jacques Le Roux a écrit :
>>> That file is containing a line that excludes the meta-data files from
>>> their previous location “**/framework/base/src/main/java/META-INF/**” My
>>> commit moved those files to
>>> “**/framework/base/src/main/resources/META-INF/**”, so IMO we should
>>> adapt the exclusion line.
>>
>> Well spotted, indeed that's the right solution 
>
> Done: I changed to the right location, that's all

Thanks you Jacques,

-- 
Mathieu Lirzin
GPG: F2A3 8D7E EB2B 6640 5761  070D 0ADE E100 9460 4D37

Re: ASL2 header for meta-data files

Posted by Jacques Le Roux <ja...@les7arts.com>.
Le 03/09/2019 à 17:28, Jacques Le Roux a écrit :
>> That file is containing a line that excludes the meta-data files from
>> their previous location “**/framework/base/src/main/java/META-INF/**” My
>> commit moved those files to
>> “**/framework/base/src/main/resources/META-INF/**”, so IMO we should
>> adapt the exclusion line.
>
> Well spotted, indeed that's the right solution 

Done: I changed to the right location, that's all

Jacques


Re: ASL2 header for meta-data files

Posted by Jacques Le Roux <ja...@les7arts.com>.
>> Reading https://www.apache.org/legal/src-headers.html#faq-siteindocs and sequel, specifically:
>>
>>     /"If in doubt about the extent of the file's creativity, add the license header to the file."/
> After reading that, I would consider those files as “no creativity
> without doubt”.

OK, no problem with me


>
>> It seems to me that all these files should have an ASL2 header.
>> All similar others have it so I guess it's easier to put it in this one and go ahead. Else we would need to put these files as exceptions in
>>
>> https://svn.apache.org/repos/asf/ofbiz/tools/rat-excludes.txt
> That file is containing a line that excludes the meta-data files from
> their previous location “**/framework/base/src/main/java/META-INF/**” My
> commit moved those files to
> “**/framework/base/src/main/resources/META-INF/**”, so IMO we should
> adapt the exclusion line.

Well spotted, indeed that's the right solution


>
> I see that some “*.xsd” are excluded which seems undesirable since
> writing an XML schema is most of the time creative work.

Actually those are external DTD so that's right there


>
> As a side note, I would highly recommend merging the "tools" repository
> inside “ofbiz-framework” repository to avoid issues like this one and
> help coordinating the maintenance of those tools.
>
> What do you think?

It was there before. But Taher (and maybe others) did not want it in the framework. So I moved it. It can be discussed again I guess.

Jacques


Re: ASL2 header for meta-data files

Posted by Mathieu Lirzin <ma...@nereide.fr>.
Jacques Le Roux <ja...@les7arts.com> writes:

> Le 03/09/2019 à 15:32, Mathieu Lirzin a écrit :
>> Hello Jacques,
>>
>>
>>> Le 26/08/2019 à 13:47, Jacques Le Roux a écrit :
>>>> If we need the stuff like
>>>>
>>>>     org.apache.ofbiz.base.util.test.UtilObjectTests$TestFactoryIntf
>>>>
>>>> Then this one misses an ASL2 header
>>>>
>>>> I was also wondering how they are updated, when compiling? If so how is the ASL2 header added?
>> Those files are meta-data files that are maintained manually. They are
>> distributed inside the JAR to allow the ‘ServiceLoader’ API [1] to find
>> the classes implementing a particular interface (corresponding to the
>> file name) efficiently.
>> [1]https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html
>>
>> According to the specification, those files can include comments using
>> the # character so technically we could add the ASL2 header, however I
>> am not sure if we should/must copyright them.
>>
>> What are the recommandation of the ASF regarding meta-data or
>> configuration files?
>
> Reading https://www.apache.org/legal/src-headers.html#faq-siteindocs and sequel, specifically:
>
>    /"If in doubt about the extent of the file's creativity, add the license header to the file."/

After reading that, I would consider those files as “no creativity
without doubt”.

> It seems to me that all these files should have an ASL2 header.
> All similar others have it so I guess it's easier to put it in this one and go ahead. Else we would need to put these files as exceptions in
>
> https://svn.apache.org/repos/asf/ofbiz/tools/rat-excludes.txt

That file is containing a line that excludes the meta-data files from
their previous location “**/framework/base/src/main/java/META-INF/**” My
commit moved those files to
“**/framework/base/src/main/resources/META-INF/**”, so IMO we should
adapt the exclusion line.

I see that some “*.xsd” are excluded which seems undesirable since
writing an XML schema is most of the time creative work.

As a side note, I would highly recommend merging the "tools" repository
inside “ofbiz-framework” repository to avoid issues like this one and
help coordinating the maintenance of those tools.

What do you think?

-- 
Mathieu Lirzin
GPG: F2A3 8D7E EB2B 6640 5761  070D 0ADE E100 9460 4D37