Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "About files"
| Line 2: | Line 2: | ||
It is an Eclipse Foundation requirement for Europa projects that the [http://www.eclipse.org/legal/guidetolegaldoc.php#Abouts About file] (about.html) exist and be accurate for every plug-in, whether it contains third party code or not. Recently I have noticed that the abouts are not an accurate reflection of the third party code redistributed in that plug-in or worse, the about file is missing! There are 2 basic [http://www.eclipse.org/legal/epl/about.php about templates]: | It is an Eclipse Foundation requirement for Europa projects that the [http://www.eclipse.org/legal/guidetolegaldoc.php#Abouts About file] (about.html) exist and be accurate for every plug-in, whether it contains third party code or not. Recently I have noticed that the abouts are not an accurate reflection of the third party code redistributed in that plug-in or worse, the about file is missing! There are 2 basic [http://www.eclipse.org/legal/epl/about.php about templates]: | ||
| − | * | + | *about for plug-ins that contain [http://www.eclipse.org/legal/epl/about.php#short ONLY EPL CONTENT] |
| − | * | + | *about for plug-ins that contain some or all [http://www.eclipse.org/legal/epl/about.php#long NON-EPL CONTENT] - sometimes we refer to this as third party content |
| − | The platform also | + | The platform also uses an [[src-about.html | ABOUT file for SOURCE PLUG-INS]]. |
| + | |||
| + | The Lucene plug-in demonstrates a simple example of an [[lucene-about.html | about that contains third party content]]. | ||
| + | Notice the link to license files. | ||
| + | |||
| + | POINTS TO REMEMBER: | ||
| + | *Nested third party code must be identified in the about and all licenses applicable to all third party content in the plug-in should be linked from or present in the about.html file. See the about in Tomcat in the platform for an example of this. | ||
| + | *Encryption (either use of or implementation of) should be identified in the about. See the about for JSch in the platform for an example of this. | ||
Revision as of 21:25, 4 June 2007
About Files
It is an Eclipse Foundation requirement for Europa projects that the About file (about.html) exist and be accurate for every plug-in, whether it contains third party code or not. Recently I have noticed that the abouts are not an accurate reflection of the third party code redistributed in that plug-in or worse, the about file is missing! There are 2 basic about templates:
- about for plug-ins that contain ONLY EPL CONTENT
- about for plug-ins that contain some or all NON-EPL CONTENT - sometimes we refer to this as third party content
The platform also uses an ABOUT file for SOURCE PLUG-INS.
The Lucene plug-in demonstrates a simple example of an about that contains third party content. Notice the link to license files.
POINTS TO REMEMBER:
- Nested third party code must be identified in the about and all licenses applicable to all third party content in the plug-in should be linked from or present in the about.html file. See the about in Tomcat in the platform for an example of this.
- Encryption (either use of or implementation of) should be identified in the about. See the about for JSch in the platform for an example of this.