Re: [PATCH 3/6] crownbay README: add WebTitle & Compliance information

[Tom Zanussi <tom.zanussi@intel.com>]

On Tue, 2012-10-23 at 13:24 -0700, nitin.a.kamble@intel.com wrote:
> From: Nitin A Kamble <nitin.a.kamble@intel.com>
> 
> The WebTitle will be used to publish the BSP on the Yocto Project Website.
> And adding the Yocto Project Compliance information for the 1.3 release.
> Also specifying all the layers used from meta-intel repository.
> 
> Signed-off-by: Nitin A Kamble <nitin.a.kamble@intel.com>
> ---
>  meta-crownbay/README |   13 +++++++++++--
>  1 files changed, 11 insertions(+), 2 deletions(-)
> 
> diff --git a/meta-crownbay/README b/meta-crownbay/README
> index 4bc9f31..3996a94 100644
> --- a/meta-crownbay/README
> +++ b/meta-crownbay/README
> @@ -2,13 +2,22 @@ This README file contains information on building the meta-crownbay
>  BSP layer, and booting the images contained in the /binary directory.
>  Please see the corresponding sections below for details.
>  
> -The Crown Bay platform consists of the Intel Atom Z6xx processor,
> +The Crown Bay platform consists of the Intel Atom E6xx processor,
>  plus the Intel EG20T Platform Controller Hub (Tunnel Creek + Topcliff).
>  
>  It also supports the E6xx embedded on-chip graphics via the Intel
>  Embedded Media and Graphics Driver (EMGD) 1.14 Driver.
>  
> 
> +WebTitle: Intel Atom E6xx processor with Intel EG20T Controller Hub development kit (crownbay)
> +

I'm not sure this kind of thing should be in the README since we can
have multiple downloadable BSPs per layer e.g. crownbay vs
crownbay-noemgd.  I suppose in keeping with the build system you could
have separate WebTitle_crownbay and WebTitle_crownbay-noemgd lines. ;-) 
(and it would be nice if you could get rid of the CamelCaps too)

Why not put this info in the machine.conf, where we already have fields
meant to be machine parseable e.g.

#@TYPE: Machine
#@NAME: crownbay

#@WEBTITLE: ...

Or maybe just use the exisiting #@DESCRIPTION for that...

> +
> +Compliance:
> +============

For consistency with the rest of the README, please remove the colon and
clean up the underlining.

Thanks,

Tom

> +This BSP is compliant with Yocto Project as per requirements listed here:
> +http://www.yoctoproject.org/yocto-project-compatible-registration
> +
> +
>  Dependencies
>  ============
>  
> @@ -22,7 +31,7 @@ This layer depends on:
>    branch: master
>  
>    URI: git://git.yoctoproject.org/meta-intel
> -  layers: intel
> +  layers: meta-intel, meta-crownbay
>    branch: master
>  
>