Re: [PATCH 2/2] yocto-bsp: clarify help with reference to meta-intel

[Darren Hart <dvhart@linux.intel.com>]

On 04/27/2012 12:00 PM, tom.zanussi@intel.com wrote:
> From: Tom Zanussi <tom.zanussi@intel.com>
> 
> The current yocto-bsp help assumes knowledge that the meta-intel layer
> needs to be cloned before it's put into the BBLAYERS.  Avoid the
> guesswork and state the details explicitly in the help.
> 
> Also, the shorter 'usage' string doesn't mention it at all; it would
> help to at minimum mention it and refer the user to the detailed help.
> 
> Fixes [YOCTO #2330].
> 
> Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>

Some minor nits below:

> ---
>  scripts/lib/bsp/help.py |   40 ++++++++++++++++++++++++++++++++++++++++
>  1 files changed, 40 insertions(+), 0 deletions(-)
> 
> diff --git a/scripts/lib/bsp/help.py b/scripts/lib/bsp/help.py
> index f78b09b..f849833 100644
> --- a/scripts/lib/bsp/help.py
> +++ b/scripts/lib/bsp/help.py
> @@ -115,6 +115,18 @@ yocto_bsp_create_usage = """
>   'properties' that will be used to fill out the BSP-specific portions
>   of the BSP.  The possible values for the 'karch' paramter can be
>   listed via 'yocto-bsp list karch'.
> +
> + NOTE: Once created, you should add your new layer to your
> + bblayers.conf file in order for it to be subsquently seen and
> + modified by the yocto-kernel tool.
> +
> + See 'yocto bsp help create' for more detailed instructions.
> +
> + NOTE for x86- and x86_64-based BSPs: The generated BSP assumes the
> + presence of the of the meta-intel layer, so you should also have a
> + meta-intel layer present and added to your bblayers.conf as well.

Consider:

+ NOTE: For x86- and x86_64-based BSPs, the generated BSP assumes the
+ presence of the of the meta-intel layer. Ensure the meta-intel layer
+ is present and added to bblayers.conf.


> +
> + See 'yocto bsp help create' for more detailed instructions.
>  """
>  
>  yocto_bsp_create_help = """
> @@ -159,9 +171,37 @@ DESCRIPTION
>      bblayers.conf file in order for it to be subsquently seen and
>      modified by the yocto-kernel tool.
>  
> +    For example, assuming your poky repo is at /path/to/poky, your
> +    your new BSP layer is at /path/to/poky/meta-mybsp, and your build


The word "your" appears twice in a row.


> +    directory is /path/to/build:
> +
> +    $ gedit /path/to/build/conf/bblayers.conf
> +
> +    BBLAYERS ?= " \\
> +      /path/to/poky/meta \\
> +      /path/to/poky/meta-yocto \\
> +      /path/to/poky/meta-mybsp \\
> +      "
> +
>      NOTE for x86- and x86_64-based BSPs: The generated BSP assumes the
>      presence of the of the meta-intel layer, so you should also have a
>      meta-intel layer present and added to your bblayers.conf as well.

OK, this is just context, but same comment as above.

> +
> +    For example, assuming your poky repo is at /path/to/poky, your
> +    your new BSP layer is at /path/to/poky/meta-mybsp, and your build

Same double "your" here as well.

> +    directory is /path/to/build:
> +
> +    $ cd /path/to/poky
> +    $ git clone git://git.yoctoproject.org/meta-intel.git
> +
> +    $ gedit /path/to/build/conf/bblayers.conf
> +
> +    BBLAYERS ?= " \\
> +      /path/to/poky/meta \\
> +      /path/to/poky/meta-yocto \\
> +      /path/to/poky/meta-intel \\
> +      /path/to/poky/meta-mybsp \\
> +      "
>  """
>  
>  yocto_bsp_list_usage = """

-- 
Darren Hart
Intel Open Source Technology Center
Yocto Project - Linux Kernel