[yocto] does a BSP layer *require* a README file?

Rifenbark, Scott M scott.m.rifenbark at intel.com
Wed Jul 25 10:05:11 PDT 2012


Ok - this helps to further clarify things.  

-----Original Message-----
From: yocto-bounces at yoctoproject.org [mailto:yocto-bounces at yoctoproject.org] On Behalf Of Mark Hatle
Sent: Wednesday, July 25, 2012 10:00 AM
To: yocto at yoctoproject.org
Subject: Re: [yocto] does a BSP layer *require* a README file?

On 7/25/12 11:46 AM, Rifenbark, Scott M wrote:
> Here is some more information on this topic.  All layers are not BSP layers (i.e the meta-tlk layer is not a BSP).  Regarding the real question as to whether a BSP layer *must* have a README file to be considered Yocto-compliant, I have been told that it does need the file.

The compliance document indicates that all layers must contain a README that 
specifies a minimum set of information.

"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"

The BSP document may require additional information as well.  I found what I 
think is good example of this type of README file in:
   http://git.yoctoproject.org/cgit.cgi/meta-baryon/tree/README

--Mark

> Scott
>
> -----Original Message-----
> From: yocto-bounces at yoctoproject.org [mailto:yocto-bounces at yoctoproject.org] On Behalf Of Rifenbark, Scott M
> Sent: Wednesday, July 25, 2012 8:00 AM
> To: Robert P. J. Day; Yocto discussion list
> Subject: Re: [yocto] does a BSP layer *require* a README file?
>
> There recently was a concern that we document the requirements of a BSP layer so that it could be considered Yocto-compliant.  The BSP guide does lay out the "must" word in that new section where it talks about the README File.  Is it really required?  Opinions?
>
> Scott
>
> -----Original Message-----
> From: yocto-bounces at yoctoproject.org [mailto:yocto-bounces at yoctoproject.org] On Behalf Of Robert P. J. Day
> Sent: Tuesday, July 24, 2012 2:22 PM
> To: Yocto discussion list
> Subject: [yocto] does a BSP layer *require* a README file?
>
>
>    currently, the BSP guide seems quite adamant that a BSP layer *must*
> have a top-level README file, but at least a couple of the meta-intel
> sublayers (meta-tlk, meta-n450) have no such file.  so should that
> alleged requirement be, you know, dropped?
>
> rday
>

_______________________________________________
yocto mailing list
yocto at yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto



More information about the yocto mailing list