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

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/