Bug 535339 - All repositories need a NOTICE and LICENSE file
Summary: All repositories need a NOTICE and LICENSE file
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Releng (show other bugs)
Version: 4.8   Edit
Hardware: All All
: P2 normal (vote)
Target Milestone: 4.10   Edit
Assignee: Sravan Kumar Lakkimsetti CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2018-05-30 10:37 EDT by Dani Megert CLA
Modified: 2022-10-22 08:51 EDT (History)
5 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Dani Megert CLA 2018-05-30 10:37:27 EDT
All repositories need a NOTICE and LICENSE file.

For details see bug 535136 comment 2.
Comment 1 Sravan Kumar Lakkimsetti CLA 2018-08-23 02:45:24 EDT
There are plans for this. Will revisit in 4.10
Comment 2 Sravan Kumar Lakkimsetti CLA 2018-08-23 02:46:37 EDT
will look into this in RC1
Comment 3 Eclipse Genie CLA 2018-08-24 05:39:04 EDT
New Gerrit change created: https://git.eclipse.org/r/127990
Comment 4 Eclipse Genie CLA 2018-08-24 05:39:07 EDT
New Gerrit change created: https://git.eclipse.org/r/127991
Comment 5 Eclipse Genie CLA 2018-08-24 05:39:09 EDT
New Gerrit change created: https://git.eclipse.org/r/127992
Comment 6 Eclipse Genie CLA 2018-08-24 05:39:11 EDT
New Gerrit change created: https://git.eclipse.org/r/127993
Comment 7 Eclipse Genie CLA 2018-08-24 05:39:24 EDT
New Gerrit change created: https://git.eclipse.org/r/127994
Comment 8 Eclipse Genie CLA 2018-08-24 05:39:27 EDT
New Gerrit change created: https://git.eclipse.org/r/127995
Comment 9 Eclipse Genie CLA 2018-08-24 05:39:29 EDT
New Gerrit change created: https://git.eclipse.org/r/127996
Comment 10 Eclipse Genie CLA 2018-08-24 05:39:42 EDT
New Gerrit change created: https://git.eclipse.org/r/127997
Comment 11 Eclipse Genie CLA 2018-08-24 05:39:44 EDT
New Gerrit change created: https://git.eclipse.org/r/127998
Comment 12 Eclipse Genie CLA 2018-08-24 05:39:56 EDT
New Gerrit change created: https://git.eclipse.org/r/127999
Comment 13 Eclipse Genie CLA 2018-08-24 05:40:11 EDT
New Gerrit change created: https://git.eclipse.org/r/128000
Comment 14 Eclipse Genie CLA 2018-08-24 05:40:13 EDT
New Gerrit change created: https://git.eclipse.org/r/128001
Comment 15 Eclipse Genie CLA 2018-08-24 05:40:25 EDT
New Gerrit change created: https://git.eclipse.org/r/128002
Comment 16 Eclipse Genie CLA 2018-08-24 05:40:28 EDT
New Gerrit change created: https://git.eclipse.org/r/128003
Comment 17 Eclipse Genie CLA 2018-08-24 05:40:40 EDT
New Gerrit change created: https://git.eclipse.org/r/128004
Comment 18 Eclipse Genie CLA 2018-08-24 05:40:52 EDT
New Gerrit change created: https://git.eclipse.org/r/128005
Comment 19 Eclipse Genie CLA 2018-08-24 05:41:05 EDT
New Gerrit change created: https://git.eclipse.org/r/128006
Comment 20 Eclipse Genie CLA 2018-08-24 05:41:07 EDT
New Gerrit change created: https://git.eclipse.org/r/128007
Comment 21 Eclipse Genie CLA 2018-08-24 05:41:30 EDT
New Gerrit change created: https://git.eclipse.org/r/128008
Comment 22 Eclipse Genie CLA 2018-08-24 05:41:52 EDT
New Gerrit change created: https://git.eclipse.org/r/128010
Comment 23 Eclipse Genie CLA 2018-08-24 05:41:55 EDT
New Gerrit change created: https://git.eclipse.org/r/128009
Comment 24 Eclipse Genie CLA 2018-08-24 05:41:57 EDT
New Gerrit change created: https://git.eclipse.org/r/128011
Comment 25 Eclipse Genie CLA 2018-08-24 05:42:09 EDT
New Gerrit change created: https://git.eclipse.org/r/128012
Comment 26 Eclipse Genie CLA 2018-08-24 05:42:12 EDT
New Gerrit change created: https://git.eclipse.org/r/128013
Comment 27 Eclipse Genie CLA 2018-08-24 05:42:25 EDT
New Gerrit change created: https://git.eclipse.org/r/128014
Comment 28 Eclipse Genie CLA 2018-08-24 05:43:08 EDT
New Gerrit change created: https://git.eclipse.org/r/128015
Comment 29 Sravan Kumar Lakkimsetti CLA 2018-08-24 05:47:04 EDT
@Dani,

Can you please review these patches?
Comment 30 Dani Megert CLA 2018-08-24 06:32:28 EDT
(In reply to Sravan Kumar Lakkimsetti from comment #29)
> @Dani,
> 
> Can you please review these patches?

Did you create the files manually or with a tool? For example I see ISpell mentioned in the JDT Core repository, but it's (only) in JDT UI.

Maybe Alex can review it since he already did this for RT (without p2).
Comment 31 Alexander Kurtakov CLA 2018-08-24 06:37:27 EDT
I may look at this one only after fixing jdt.debug tests and the rest of epl 2 patches.
Comment 32 Sravan Kumar Lakkimsetti CLA 2018-08-24 06:42:51 EDT
I created these files with the tool 
https://www.eclipse.org/projects/tools/documentation.php

From the eclipse project point of view we have 4 projects with multiple repositories. 

1. JDT
2. PDE
3. Equinox and
4. Platform

accordingly the documentation has been generated by the Legal Documentation Generator available here https://www.eclipse.org/projects/tools/documentation.php. 

I am not sure if we need to customize for individual git repos.
Comment 33 Dani Megert CLA 2018-08-24 06:48:46 EDT
(In reply to Alexander Kurtakov from comment #31)
> I may look at this one only after fixing jdt.debug tests and the rest of epl
> 2 patches.

That would be great!
Comment 34 Dani Megert CLA 2018-08-24 06:52:27 EDT
(In reply to Sravan Kumar Lakkimsetti from comment #32)
> I created these files with the tool 
> https://www.eclipse.org/projects/tools/documentation.php

The generator is marked experimental and says:

Some information may be missing; it is ultimately the project team's responsibility to provide this information.

I assume you did not validate the generated stuff, because that is a lot of work. I think we should go back to Wayne and ask how experimental the tool really is these days.

 
> From the eclipse project point of view we have 4 projects with multiple
> repositories. 
> 
> 1. JDT
> 2. PDE
> 3. Equinox and
> 4. Platform

OK.
Comment 35 Alexander Kurtakov CLA 2018-08-24 06:53:53 EDT
(In reply to Dani Megert from comment #33)
> (In reply to Alexander Kurtakov from comment #31)
> > I may look at this one only after fixing jdt.debug tests and the rest of epl
> > 2 patches.
> 
> That would be great!

Yeah, but it may mean post RC1 as there is a lot of EPL 2 stuff pending.
Comment 36 Dani Megert CLA 2018-08-24 06:58:55 EDT
(In reply to Alexander Kurtakov from comment #35)
> (In reply to Dani Megert from comment #33)
> > (In reply to Alexander Kurtakov from comment #31)
> > > I may look at this one only after fixing jdt.debug tests and the rest of epl
> > > 2 patches.
> > 
> > That would be great!
> 
> Yeah, but it may mean post RC1 as there is a lot of EPL 2 stuff pending.

When you did it for Equinox, did you verify all the generated files?
Comment 37 Alexander Kurtakov CLA 2018-08-24 07:04:07 EDT
(In reply to Dani Megert from comment #36)
> (In reply to Alexander Kurtakov from comment #35)
> > (In reply to Dani Megert from comment #33)
> > > (In reply to Alexander Kurtakov from comment #31)
> > > > I may look at this one only after fixing jdt.debug tests and the rest of epl
> > > > 2 patches.
> > > 
> > > That would be great!
> > 
> > Yeah, but it may mean post RC1 as there is a lot of EPL 2 stuff pending.
> 
> When you did it for Equinox, did you verify all the generated files?

I don't remember doing it for Equinox nor I can see these files in p2 repo.
Comment 38 Alexander Kurtakov CLA 2018-08-24 07:07:04 EDT
(In reply to Alexander Kurtakov from comment #37)
> (In reply to Dani Megert from comment #36)
> > (In reply to Alexander Kurtakov from comment #35)
> > > (In reply to Dani Megert from comment #33)
> > > > (In reply to Alexander Kurtakov from comment #31)
> > > > > I may look at this one only after fixing jdt.debug tests and the rest of epl
> > > > > 2 patches.
> > > > 
> > > > That would be great!
> > > 
> > > Yeah, but it may mean post RC1 as there is a lot of EPL 2 stuff pending.
> > 
> > When you did it for Equinox, did you verify all the generated files?
> 
> I don't remember doing it for Equinox nor I can see these files in p2 repo.

I guess you refer to http://git.eclipse.org/c/equinox/rt.equinox.bundles.git/commit/CONTRIBUTING?id=a81821be15dd8130d1976c11d7a30488c58c3514
but it was simply fixing URL, nothing more.
Comment 39 Dani Megert CLA 2018-08-24 07:09:03 EDT
(In reply to Alexander Kurtakov from comment #38)
> (In reply to Alexander Kurtakov from comment #37)
> > (In reply to Dani Megert from comment #36)
> > > (In reply to Alexander Kurtakov from comment #35)
> > > > (In reply to Dani Megert from comment #33)
> > > > > (In reply to Alexander Kurtakov from comment #31)
> > > > > > I may look at this one only after fixing jdt.debug tests and the rest of epl
> > > > > > 2 patches.
> > > > > 
> > > > > That would be great!
> > > > 
> > > > Yeah, but it may mean post RC1 as there is a lot of EPL 2 stuff pending.
> > > 
> > > When you did it for Equinox, did you verify all the generated files?
> > 
> > I don't remember doing it for Equinox nor I can see these files in p2 repo.
> 
> I guess you refer to
> http://git.eclipse.org/c/equinox/rt.equinox.bundles.git/commit/CONTRIBUTING?id=a81821be15dd8130d1976c11d7a30488c58c3514
> 
> but it was simply fixing URL, nothing more.

Indeed.
Comment 40 Dani Megert CLA 2018-08-24 07:10:57 EDT
Sravan, can you please ask Wayne regarding the tool? It doesn't look feasible to verify the generated files manually against all our projects.
Comment 41 Sravan Kumar Lakkimsetti CLA 2018-08-24 07:35:56 EDT
@wayne,

I generated the required files using the tool at https://www.eclipse.org/projects/tools/documentation.php. 

There are some questions regarding this tool and general update for the repos. 

1. How accurate is the tool. like what kind of information is missing?
2. There are 4 top level projects for SDK with multiple repositories. My plan is to use same legal documentation for all the repositories under that project. There are some issues here. like the one mentioned by Dani in comment 30. How to proceed on this.
3. Do we need to individually tailor this legal documentation for the individual repos?
Comment 42 Wayne Beaton CLA 2018-08-27 10:22:22 EDT
(In reply to Sravan Kumar Lakkimsetti from comment #41)
> 1. How accurate is the tool. like what kind of information is missing?

The tool is as accurate the the underlying data that drives it. It gets the project description, for example, from the PMI. If you want to change what gets generated, you can make the change in the PMI.

As you've likely noticed, the generator doesn't handle the project roll up (i.e. the generated NOTICE file for the TLP doesn't include any information from subprojects). So, some customization is required for projects that have subprojects.

Just drop the section on third party content; that information will be captured in your about.html files already, so it's not strictly needed here as well (keeping that up to date in the NOTICE will be a painful challenge).

> 2. There are 4 top level projects for SDK with multiple repositories. My
> plan is to use same legal documentation for all the repositories under that
> project. There are some issues here. like the one mentioned by Dani in
> comment 30. How to proceed on this.

I think that dropping the third party content section addresses Dani's question. Correct me if I'm wrong.

> 3. Do we need to individually tailor this legal documentation for the
> individual repos?

I think that you really want to. Updating a dozen of these files is going to be painful. If you take out the third party content list, I think that you can make a single file work.

I think that the main challenge is going to be keeping the list of repositories up-to-date. I see that you've provided a list; that should work for now. I've opened Bug 538313; once we address that you can just provide a link to the "Developer Resources" page and--as long as the project metadata is maintained--you'll always have an up-to-date list.

Thanks for addressing this.
Comment 43 Dani Megert CLA 2018-08-27 11:55:51 EDT
(In reply to Wayne Beaton from comment #42)
> > 3. Do we need to individually tailor this legal documentation for the
> > individual repos?
> 
> I think that you really want to. Updating a dozen of these files is going to
> be painful. If you take out the third party content list, I think that you
> can make a single file work.

I'm not sure I understood. Did you want to say "I DONT'T think..."? Or did you mean that we have to tailor one file to match everything?

Can we move this to 4.10?
Comment 44 Wayne Beaton CLA 2018-08-27 12:49:44 EDT
(In reply to Dani Megert from comment #43)
> (In reply to Wayne Beaton from comment #42)
> > > 3. Do we need to individually tailor this legal documentation for the
> > > individual repos?
> > 
> > I think that you really want to. Updating a dozen of these files is going to
> > be painful. If you take out the third party content list, I think that you
> > can make a single file work.
> 
> I'm not sure I understood. Did you want to say "I DONT'T think..."? Or did
> you mean that we have to tailor one file to match everything?

It appears that I mistyped. My apologies. One common set of files seems easier for everybody.

> Can we move this to 4.10?

Yes.
Comment 45 Dani Megert CLA 2018-08-27 13:06:24 EDT
Sravan please work on this for 4.10 along the lines given by Wayne.
Comment 46 Sravan Kumar Lakkimsetti CLA 2018-09-18 06:48:07 EDT
@wayne,

I used https://www.eclipse.org/projects/tools/documentation.php to generate these files. 

Shall I proceed with dropping third party content from the notice file? If so then we need to fix the tool as well as the tool generetaes all the third party content into notice file
Comment 47 Sravan Kumar Lakkimsetti CLA 2018-10-25 02:18:46 EDT
(In reply to Sravan Kumar Lakkimsetti from comment #46)
> @wayne,
> 
> I used https://www.eclipse.org/projects/tools/documentation.php to generate
> these files. 
> 
> Shall I proceed with dropping third party content from the notice file? If
> so then we need to fix the tool as well as the tool generetaes all the third
> party content into notice file
@wayne, Can you please let me know whether I can proceed with this?
Comment 48 Wayne Beaton CLA 2018-11-13 09:31:47 EST
(In reply to Sravan Kumar Lakkimsetti from comment #46)
> Shall I proceed with dropping third party content from the notice file? 

Yes.

> If
> so then we need to fix the tool as well as the tool generetaes all the third
> party content into notice file

The tool is intended to provide a template. The current implementation is appropriate for projects that do not build Eclipse Platform plug-ins and so do not have this information captured elsewhere. I'll see what I can do (time permitting).

In the meantime, I'll add some instructions to the generator to remind committers that the content can and should be tuned for specific circumstances.
Comment 49 Eclipse Genie CLA 2018-11-14 10:13:05 EST
New Gerrit change created: https://git.eclipse.org/r/132430
Comment 50 Eclipse Genie CLA 2018-11-14 10:13:27 EST
New Gerrit change created: https://git.eclipse.org/r/132431
Comment 51 Eclipse Genie CLA 2018-11-14 10:13:40 EST
New Gerrit change created: https://git.eclipse.org/r/132432
Comment 78 Sravan Kumar Lakkimsetti CLA 2018-11-14 10:32:15 EST
Updated the necessary legal documentation on all the repos. Used https://www.eclipse.org/projects/tools/documentation.php tool to generate necessary documentation
Comment 79 Some User CLA 2022-10-22 08:51:12 EDT
A bit late, but should `NOTICE` and `CONTRIBUTING` have the file extension `.md`? Both seem to contain Markdown content. This would make editing them easier, and would make it easier to read them in the IDE or browser (at least for Eclipse projects hosted / mirrored to GitHub, such as JDT).

If possible it might also be good to replace the HTTP URLs in `NOTICE` and `CONTRIBUTING` with HTTPS URLs (and update the tool which generated these URLs).

(Though I can't make that change since I have not signed the ECA and am not familiar with the workflows of the projects.)