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"
(About Files in Eclipse) |
|||
| Line 7: | Line 7: | ||
The platform also uses an [[src-about.html | ABOUT file for SOURCE PLUG-INS]]. | The platform also uses an [[src-about.html | ABOUT file for SOURCE PLUG-INS]]. | ||
| − | The Lucene plug-in demonstrates a simple example of an [ | + | The Lucene plug-in demonstrates a simple example of an [http://dev.eclipse.org/viewcvs/index.cgi/org.apache.lucene/about.html?view=co about that contains third party content]. |
| − | Notice the link to license files. | + | Notice the link to license files in a directory called about_files. The Europa projects tend to do this by convention so the about file isn't too long. |
POINTS TO REMEMBER: | 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 | + | *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 [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.tomcat/about.html?view=co about in the Tomcat plug-in] for an example of this (MX4J is nested). |
| − | *Encryption (either use of or implementation of) should be identified in the about. See the about for | + | *Encryption (either use of or implementation of) should be identified in the about. See the [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.core.runtime.compatibility.auth/about.html?view=co about for the Authorization Compatibility plug-in] for an example of this. |
Revision as of 21:43, 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 in a directory called about_files. The Europa projects tend to do this by convention so the about file isn't too long.
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 the Tomcat plug-in for an example of this (MX4J is nested).
- Encryption (either use of or implementation of) should be identified in the about. See the about for the Authorization Compatibility plug-in for an example of this.