[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [eclipse.org-planning-council] Fwd:[eclipse.org-architecture-council] about_files and JPMS

The original issue Stephan mentioned on the jigsaw mailing list was about the "about_files/" folder.  But here you are also discussing the root JAR resource about.html which is not located in the subfolder "about_files/" as well as the supporting files that by convention are located in the "about_files/" folder.  I'm not aware of issues with JPMS and resources in the root of the modular JAR (e.g. about.html).  If JPMS does have issues with root JAR resources then we will need to be concerned about some other common root resource files like the ".options" file which indicate the trace options available for the plugin.  If there is a "more standard" way to specify the legalise files for a JAR then I am in favor of us adopting it.
 
There are some places where the about.html is expected to be located in the root of the JAR.  For example in the about dialog when looking at Installation Details -> Plugins there is a button to view the Legal Info.  At a minimum we need to update that to look for Legal Info some other "more standard" location, but it will also have to continue to look for an about.html file for old plugins.

Tom
 
 
 
----- Original message -----
From: Gunnar Wagenknecht <gunnar@xxxxxxxxxxxxxxx>
Sent by: eclipse.org-planning-council-bounces@xxxxxxxxxxx
To: Eclipse Planning Council private list <eclipse.org-planning-council@xxxxxxxxxxx>
Cc:
Subject: [EXTERNAL] [eclipse.org-planning-council] Fwd: [eclipse.org-architecture-council] about_files and JPMS
Date: Wed, Aug 28, 2019 8:32 AM
 
Planning Council,
 
Triggered by a recent issue I started a discussion about $subject on the AC mailing list.
https://www.eclipse.org/lists/eclipse.org-architecture-council/msg04051.html
 
After a bit more research I crafted the following reply. I believe the Planning Council is technically the owner of the wiki page (About_files). Thus, I think this is of interest to you. I think there is no longer a requirement to have an about.html file in the jar/plug-in root but instead have a LICENSE file in META-INF. It also looks like the about_files folder and its content has been replaces with a NOTICE file, which _should_ go into META-INF as well.
 
I'm posting this here for visibility because it affects the train. As the about_files folder is causing technical difficulties with JPMS we are consider renaming them for EBR and thus Orbit as well. After reviewing the legal docs it looks like there is an opportunity to get rid of it completely.
 
-Gunnar
 
 
 
 
Begin forwarded message:
 
From: Gunnar Wagenknecht <gunnar@xxxxxxxxxxxxxxx>
Subject: Re: [eclipse.org-architecture-council] about_files and JPMS
Date: August 28, 2019 at 15:26:18 GMT+2
 
On Aug 28, 2019, at 13:30, Hudalla Kai (INST/ECS4) <kai.hudalla@xxxxxxxxxxxx> wrote:

The Hono (IoT) project indeed includes the legal docs in each jar file
that we distribute. I think it makes it easier for people and tooling to
determine the license that the jar can be consumed under. We put all the
legal docs into the META-INF folder ...


For some more background, I'm referring to the practice documented here:
https://wiki.eclipse.org/About_files

However, after reviewing the project handbook it seems that the requirement around legal documents accompanying a jar changed.
 
For content delivered as Java archive (JAR) files, for example, the legal files should be placed in the META-INF directory.

Thus, the requirement to have an about.html file no longer exist. I found an old reference on the page, which seems incorrect. Also, the requirement to collect about_files seems to have been replaced with the NOTICE file.

Source:
https://www.eclipse.org/projects/handbook/#legaldoc

Kai, what you are doing looks like the recommended practise to me.

-Gunnar


--
Gunnar Wagenknecht
gunnar@xxxxxxxxxxxxxxx, http://guw.io/


 
_______________________________________________
eclipse.org-planning-council mailing list
eclipse.org-planning-council@xxxxxxxxxxx
https://www.eclipse.org/mailman/listinfo/eclipse.org-planning-council

IMPORTANT: Membership in this list is generated by processes internal to the Eclipse Foundation.  To be permanently removed from this list, you must contact emo@xxxxxxxxxxx to request removal.