Working Draft of Compliance Prop

From Yocto Project
Revision as of 17:09, 31 May 2012 by Darknighte (talk | contribs) (Substituted "compatible" for "powered")
Jump to navigationJump to search

YOCTO PROJECT Compliance Guidelines

Introduction

The YOCTO PROJECT compliance program has been established to strengthen the YOCTO PROJECT strategic initiatives by providing guidelines for the use of its branding. This program is intended to provide a minimum level of standardization in order to enable both individual and corporate members to deliver implementations which support the goals of the project and contribute to an ecosystem built around the project. 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:

  • Reducing fragmentation in the embedded market by encouraging the development of and collaboration on a common set of tools, standards and practices.
  • Ensuring 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 describes 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 (add link here).

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 (palette etc) as well as when they can be used in conjunction with the above are found in the “YOCTO PROJECT Brand Usage Guide.” (add link here)

YOCTO PROJECT Aligned

Registration Steps

To register compliance for use of the YOCTO PROJECT Aligned logo/text:
  1. Edit the designated wiki page as follows:
    1. copy the text below
    2. add a new section for your project / organization
  2. Send email to the Yocto Advisory Board requesting registration
  3. When you have received email acknowledgement, you may use the logo / text treatment

YOCTO PROJECT Aligned 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
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")
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")
Aim for compatibility and interoperability between 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 Aligned 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
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
Committed to sending to the open source community any patches to OpenEmbedded-Core, BitBake and other YOCTO PROJECT layers Y
Aim for compatibility and interoperability between 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:
  1. Edit the designated wiki page as follows:
    1. copy the text below
    2. add a new section for your project / organization
  2. Send email to the Yocto Advisory Board requesting registration
  3. When you have received email acknowledgement, you may use the logo / text treatment


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 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")
A test report document is included of 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? 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

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 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
A test report document is included of 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? Y