Working Draft of Compliance Prop
From Yocto Project
Jump to navigationJump to search
Yocto Project Compliance Guidelines
Introduction
The Yocto Project compliance program strengthens the Yocto Project strategic initiatives by providing guidelines for the use of its branding. This program provides a minimum level of standardization in order to enable both individual contributors and corporate members to deliver implementations which support the project's goals and contribute to its ecosystem. In addition, this program is intended to provide concrete benefits by associating a common set of definitions with the use of the Yocto Project branding.
Some of the goals of the Yocto Project that the compliance program is intended to strengthen include:
- Reduce fragmentation in the embedded market by encouraging collaborative development of a common set of tools, standards, and practices.
- Ensure that these tools, standards, and practices are architecturally independent as much as possible.
Compliance as defined by the Yocto Project governs the rights for the usage of the project name, logo, and marks in association with products, marketing materials, and announcements. The Yocto Project brand guidelines describe how members that follow these compliance guidelines are allowed to use these rights. (Add document link here – document and guidelines are in development)
As with Linux, compliance affects the commercial use of resulting products or projects created by the Yocto Project. Personal use cases are not covered.
Note: The Yocto Project adheres to the guidelines set up by the Linux Foundation. Your right to use this mark is conditioned to conforming to the Linux Foundation trademark usage guidelines.
Compliance levels, Compliance Recommendations and Terminology
The Yocto Project compliance program defines steps to register compliance for both individual and corporate members.
Yocto Project Brand Documentation
Clear documentation how the brands can be used (logo, marks, palette, etc.) as well as when they can be used in conjunction with the above are found in the “Yocto Project Brand Usage Guide.” (NOTE: Brand Usage Guide is in process & will be available soon.)
Yocto Project Participant
Registration Steps
- To register compliance for use of the Yocto Project Participant logo/text:
- Edit the designated wiki page as follows:
- copy the text below
- add a new section for your project / organization
- Send email to the Yocto Advisory Board requesting registration
- When you have received email acknowledgement, you may use the logo / text treatment
- Edit the designated wiki page as follows:
Yocto Project Participant Registration Template
| Organization / Project name | (Replace with text) |
| Contact Name / Email address | (Replace with text) |
| Registration Date | (Replace with text) |
| Compliance specification revision | Version 1.0 |
| URL to organization or product link | (replace with appropriate URL) |
| Criteria | Yes/No | Explanation (if N or N/A) |
| Working towards and supporting the aims and objectives of the Yocto Project. These include decreasing the fragmentation of embedded ecosystem and focusing around a common shared set of tools, formats and best practices. We want to avoid multiple groups of people repeating the same work and have one set of great tools rather than multiple tools with drawbacks. | Y or N | (Delete if "Y") |
| Promoting the OpenEmbedded architecture, layer model, and BSP format. | Y or N | (Delete if "Y") |
| Committed to sending to the open source community any patches to OpenEmbedded-Core, BitBake and other Yocto Project layers. | Y or N | (Delete if "Y") |
| Aiming for compatibility and interoperability among different metadata layers. | Y or N | (Delete if "Y") |
| Be an open source project, non-profit, small business (up to 80 employees). | Y or N | (Delete if "Y") |
Yocto Project Participant Registrar
OpenSDR (Consultant)
| Organization / Project name | OpenSDR (Example) |
| Contact Name / Email address | Philip Balister / philip@balister.org |
| Registration Date | May 20, 2012 |
| Compliance specification revision | Version 1.0 |
| URL to organization or product link | http://opensdr.com/ |
| Criteria | Yes/No | Explanation (if N or N/A) |
| Working towards and supporting the aims and objectives of the Yocto Project. These include decreasing the fragmentation of embedded ecosystem and focusing around a common shared set of tools, formats and best practices. We want to avoid multiple groups of people repeating the same work and have one set of great tools rather than multiple tools with drawbacks. | Y | |
| Promoting the OpenEmbedded architecture, layer model, and BSP format. | Y | |
| Committed to sending to the open source community any patches to OpenEmbedded-Core, BitBake and other Yocto Project layers. | Y | |
| Aiming for compatibility and interoperability among different metadata layers. | Y | |
| Be an open source project, non-profit, small business (up to 80 employees). | Y |
Yocto Project Compatible
Registration Steps
- To register compliance for use of the Yocto Project Compatible logo/text:
- Edit the designated wiki page as follows:
- copy the text below
- add a new section for your project / organization
- Send email to the Yocto Advisory Board requesting registration
- When you have received email acknowledgement, you may use the logo / text treatment
- Edit the designated wiki page as follows:
| Organization / Project name | (Replace with text) |
| Contact Name / Email address | (Replace with text) |
| Product / Project name | (Replace with text) |
| Product release version | (Replace with text) |
| Registration Date | (Replace with text) |
| Compliance specification revision | Version 1.0 |
| Yocto version tested | (replace with appropriate release # or possibly a link ) |
| URL to organization or product link | (replace with appropriate URL) |
Yocto Project Compatible Acceptance Criteria
| Criteria | Yes/No | Explanation (if N or N/A) |
| Working towards and supporting the aims and objectives of the Yocto Project. These include decreasing the fragmentation of embedded ecosystem and focus around a common shared set of tools, formats and best practices. We want to avoid multiple groups of people repeating the same work and have one set of great tools rather than multiple tools with drawbacks. | Y or N | (Delete if "Y") |
| Promoting the OpenEmbedded architecture, layer model, and BSP format. | Y or N | (Delete if "Y") |
| Making visible contributions in the OpenEmbedded and component projects of the Yocto Project. | Y or N | (Delete if "Y") |
| Be an open source project, non-profit, or member of the Yocto Project working group, regardless of organization size. | Y or N | (Delete if "Y") |
| If the project includes build system functionality, are BitBake and OpenEmbedded-Core included as components? | Y or N | (Delete if "Y") |
| If present, can the directories containing BitBake and OpenEmbedded-Core be clearly identified within the system and only contain those components? | Y or N | (Delete if "Y") |
| Have all patches applied to BitBake and OpenEmbedded-Core (if present) been submitted to the open source community? | Y or N | (Delete if "Y") |
| Do all layers contain a README file which details the origin of the layer, its maintainer, where to submit changes, and any dependencies or version requirements? | Y or N | (Delete if "Y") |
| Do all layers build without errors against OpenEmbedded-Core with only the dependencies/requirements listed in their README file? | Y or N | (Delete if "Y") |
| (For BSPs) Does the layer follow the format defined in the Yocto Project Board Support Package (BSP) Developers Guide? | Y or N | (Delete if "Y") |
| Are hardware support, configuration (distro) policy, and recipe metadata separated into different layers which do not depend on each other? | Y or N | (Delete if "Y") |
| Is a test report document included showing which combinations of layers, recipes, and machines have been tested? | Y or N | (Delete if "Y") |
| If any item in the "Yocto Project Compatible Compliance Recommendations" list is not true, is this documented in the testing report? | Y or N | (Delete if "Y") |
Yocto Project Compatible Compliance Recommendations
| Criteria | Yes/No | Explanation (if N or N/A) |
| Linux kernels are either based around LTSI kernel versions or a Yocto Project kernel version. | Y or N | (Delete if "Y") |
| Everything builds successfully with the standard toolchain from OE-Core, where the architecture is one supported by OE-Core as standard. This is to ensure that your layers are compatible with OE-Core. It is not required that the OE-Core toolchain be provided to customers or any downstream projects. | Y or N | (Delete if "Y") |
Yocto Project Compatible Registrar
Mentor Graphics Embedded Linux
| Organization / Project name | Mentor Graphics, Inc |
| Contact Name / Email address | Sean Hudson, Sean_Hudson@mentor.com |
| Product / Project name | Mentor Embedded Linux |
| Product release version | v5.0 |
| Registration Date | March 27, 2012 |
| Compliance specification revision | Version 1.0 |
| Yocto version tested | Version 1.1 |
| URL to organization or product link | http://www.mentor.com/embedded-software/linux/ |
Mentor Graphics Yocto Project Compatible Acceptance Criteria
| Criteria | Yes/No | Explanation (if N or N/A) |
| Working towards and supporting the aims and objectives of the Yocto Project. These include decreasing the fragmentation of embedded ecosystem and focus around a common shared set of tools, formats and best practices. We want to avoid multiple groups of people repeating the same work and have one set of great tools rather than multiple tools with drawbacks. | Y | |
| Promoting the OpenEmbedded Architecture, layer model and BSP format | Y | |
| Making visible contributions in the OpenEmbedded and component projects of the Yocto Project. | Y | |
| Be an open source project, non-profit, or member of the Yocto Project working group, regardless of organization size. | Y | |
| If the project includes build system functionality, are BitBake and OpenEmbedded-Core included as components? | Y | |
| If present, can the directories containing BitBake and OpenEmbedded-Core be clearly identified within the system and only contain those components? | Y | |
| Have all patches applied to BitBake and OpenEmbedded-Core (if present) been submitted to the open source community? | Y | |
| Do all layers contain a README file which details the origin of the layer, its maintainer, where to submit changes, and any dependencies or version requirements? | Y | |
| Do all layers build without errors against OpenEmbedded-Core with only the dependencies/requirements listed in their README file? | Y | |
| (For BSPs) Does the layer follow the format defined in the Yocto Project Board Support Package (BSP) Developers Guide? | Y | |
| Are hardware support, configuration (distro) policy, and recipe metadata separated into different layers which do not depend on each other? | Y | |
| Is a test report document included showing which combinations of layers, recipes, and machines have been tested? | Y | |
| If any item in the "Yocto Project Compatible Compliance Recommendations" list is not true, is this documented in the testing report? | Y |
Mentor Graphics Yocto Project Compatible Compliance Recommendations
| Criteria | Yes/No | Explanation (if N or N/A) |
| Linux kernels are either based around LTSI kernel versions or a Yocto Project kernel version. | Y | Based on Yocto Project v1.1 |
| Everything builds successfully with the standard toolchain from OE-Core, where the architecture is one supported by OE-Core as standard. This is to ensure that your layers are compatible with OE-Core. It is not required that the OE-Core toolchain be provided to customers or any downstream projects. | Y |
